Jump to

• Request
• Response

Get details of one measure-based exception

get

/fscmRestApi/resources/11.13.18.05/supplyChainPlans/{PlanId}/child/MeasureBasedExceptions/{MeasureBasedExceptionsUniqID}

Request

Path Parameters

• MeasureBasedExceptionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ExceptionDetailId and PlanId ---for the Measure-based Exceptions resource and used to uniquely identify an instance of Measure-based Exceptions. The client should not generate the hash key value. Instead, the client should query on the Measure-based Exceptions collection resource with a filter on the primary key values in order to navigate to a specific instance of Measure-based Exceptions.
  
  For example: MeasureBasedExceptions?q=ExceptionDetailId=<value1>;PlanId=<value2>
• PlanId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  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>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : supplyChainPlans-MeasureBasedExceptions-item-response

Type: object

Show Source

• ActionTaken: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.
• BaseMeasureDate: string (date)
  Read Only: true

  Date represented as measure value for comparison with threshold in the measure-based exception.
• BaseMeasureQuantity: number
  Read Only: true

  Number that represents the measure value or quantity of the measure for comparison with threshold in the measure-based exception.
• Basis: integer (int32)
  Read Only: true

  Basis of the exception computation. Default is Measure for a measure-based exception.
• BasisValue: integer (int64)
  Read Only: true

  Value that uniquely identifies the basis in the measure-based exception.
• ClusterDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the cluster dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• ClusterHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the cluster hierarchy in the measure-based exception.
• ClusterHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the cluster hierarchy in the measure-based exception.
• ClusterLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the cluster hierarchy level in the measure-based exception.
• ClusterLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the cluster-level member in the measure-based exception.
• ClusterLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the cluster-level member in the measure-based exception.
• ClusterLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the cluster hierarchy level in the measure-based exception.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the exception detail.
• CreationDate: string (date-time)
  Read Only: true

  Date when the exception detail was created.
• CustomerDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that customer dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• CustomerHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer hierarchy in the measure-based exception.
• CustomerHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the customer hierarchy in the measure-based exception.
• CustomerLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer hierarchy level in the measure-based exception.
• CustomerLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer level member in the measure-based exception.
• CustomerLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the customer level member in the measure-based exception.
• CustomerLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the customer hierarchy level in the measure-based exception.
• DemandClassDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the demand class dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• DemandClassHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand class hierarchy in the measure-based exception.
• DemandClassHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the demand class hierarchy in the measure-based exception.
• DemandClassLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand class hierarchy level in the measure-based exception.
• DemandClassLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand class level member in the measure-based exception.
• DemandClassLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the demand class level member in the measure-based exception.
• DemandClassLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the demand class hierarchy level in the measure-based exception.
• EndDate: string (date)
  Read Only: true

  End date of the measure-based exception detail.
• Exception: string
  Title: Exception

  Read Only: true

  Maximum Length: 240

  Name of an exception.
• ExceptionAge: integer
  Read Only: true

  Number of days representing the age of the exception.
• ExceptionDetailId: integer (int64)
  Read Only: true

  Value that uniquely identifies the measure-based exception detail.
• ExceptionDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the exception dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• ExceptionHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the exception hierarchy in the measure-based exception.
• ExceptionHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the exception hierarchy in the measure-based exception.
• ExceptionId: integer (int64)
  Read Only: true

  Number that uniquely identifies an exception.
• ExceptionLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the exception hierarchy level in the measure-based exception.
• ExceptionLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the exception level member in the measure-based exception.
• ExceptionLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the exception level member in the measure-based exception.
• ExceptionLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the exception hierarchy level in the measure-based exception.
• FirstGeneratedDate: string (date)
  Read Only: true

  Date when the exception details were first generated by plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the exception detail was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the exception detail.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 240

  Login details when the exception details were last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: integer (int64)
  Title: Notes

  Contains information created or updated for an exception detail represented as notes.
• OrderTypeDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the order type dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• OrderTypeHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the order type hierarchy in the measure-based exception.
• OrderTypeHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the order type hierarchy in the measure-based exception.
• OrderTypeLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the order type hierarchy level in the measure-based exception.
• OrderTypeLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the order type level member in the measure-based exception.
• OrderTypeLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the order type level member in the measure-based exception.
• OrderTypeLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the order type hierarchy level in the measure-based exception.
• OrganizationDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the organization dimension is enabled for the measure-based exception. If 2, then dimension isn't enabled. The default value is 2.
• OrganizationHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization hierarchy in the measure-based exception.
• OrganizationHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization hierarchy in the measure-based exception.
• OrganizationLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization hierarchy level in the measure-based exception.
• OrganizationLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization level member in the measure-based exception.
• OrganizationLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization level member name in the measure-based exception.
• OrganizationLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization hierarchy level in the measure-based exception.
• PersistentId: string
  Read Only: true

  Maximum Length: 64

  Value that uniquely identifies the persistence exception detail in the measure-based exception detail.
• PlanCategoryName: string
  Read Only: true

  Maximum Length: 4000

  Name of the category to which the item is assigned in the measure-based exception.
• PlanDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the plan dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• PlanHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan hierarchy in the measure-based exception.
• PlanHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the plan hierarchy name in themeasure-based exception.
• PlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan in which exception is generated.
• PlanLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan hierarchy level in themeasure-based exception.
• PlanLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan level member in the measure-based exception.
• PlanLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the plan level member in measure-based exception.
• PlanLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the plan hierarchy level in measure-based exception.
• PlannerCode: string
  Read Only: true

  Maximum Length: 4000

  Name of the planner associated with the item in the exception.
• PlannerDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the planner associated with the item in the exception.
• ProductDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the product dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• ProductHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the product hierarchy in the measure-based exception.
• ProductHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the product hierarchy in the measure-based exception.
• ProductLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the product hierarchy level in the measure-based exception.
• ProductLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the product level member in the measure-based exception.
• ProductLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the product level member in the measure-based exception.
• ProductLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the product hierarchy level in the measure-based exception.
• ResourceDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the resource dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• ResourceHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource hierarchy in the measure-based exception.
• ResourceHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the resource hierarchy in the measure-based exception.
• ResourceLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource hierarchy level in the measure-based exception.
• ResourceLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource level member in the measure-based exception.
• ResourceLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the resource level member in the measure-based exception.
• ResourceLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the resource hierarchy level in the measure-based exception.
• ScenarioHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the scenario hierarchy in the measure-based exception.
• ScenarioHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the scenario hierarchy in the measure-based exception.
• ScenarioLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the scenario hierarchy level in the measure-based exception.
• ScenarioLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the scenario level member in the measure-based exception.
• ScenarioLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the scenario level member in the measure-based exception.
• ScenarioLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the scenario hierarchy level in the measure-based exception.
• StartDate: string (date)
  Read Only: true

  Start date of the measure-based exception detail.
• SupplierDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the supplier dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• SupplierHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier hierarchy in the measure-based exception.
• SupplierHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier hierarchy in the measure-based exception.
• SupplierLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier hierarchy level in the measure-based exception.
• SupplierLevelMember: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier level member in the measure-based exception.
• SupplierLevelMemberName: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier level member in the measure-based exception.
• SupplierLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier hierarchy level in the measure-based exception.
• ThresholdMeasureDate: string (date)
  Read Only: true

  Date represented as measure value for threshold in the measure-based exception.
• ThresholdMeasureQuantity: number
  Read Only: true

  Number that represents the threshold value or quantity of the measure in the measure-based exception.
• TimeDimEnabled: integer (int32)
  Read Only: true

  Contains one of the following values: 1 or 2. If 1, then it indicates that the time dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.
• TimeHierarchy: integer (int64)
  Read Only: true

  Value that uniquely identifies the time hierarchy in the measure-based exception.
• TimeHierarchyName: string
  Read Only: true

  Maximum Length: 240

  Name of the time hierarchy in the measure-based exception.
• TimeLevel: integer (int64)
  Read Only: true

  Value that uniquely identifies the time hierarchy level in the measure-based exception.
• TimeLevelMember: string (date)
  Read Only: true

  Value that uniquely identifies the time level member in the measure-based exception.
• TimeLevelName: string
  Read Only: true

  Maximum Length: 240

  Name of the time hierarchy level in the measure-based exception.

{
    "type":"object",
    "properties":{
        "OrganizationLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the exception detail was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the product dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan hierarchy level in themeasure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the supplier dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TimeLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the time hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the organization dimension is enabled for the measure-based exception. If 2, then dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the measure-based exception detail.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the demand class level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderTypeLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the order type level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization level member name in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the scenario hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the plan dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScenarioHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the scenario hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ScenarioLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the scenario hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TimeLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the time hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the order type level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the order type hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan level member in measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ResourceLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan hierarchy level in measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the product hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the cluster-level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionTaken":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that an action is taken to resolve the exception. If 2, then no action is taken. Default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanCategoryName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the category to which the item is assigned in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":240,
            "type":"string",
            "description":"Login details when the exception details were last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeLevelMember":{
            "type":"string",
            "description":"Value that uniquely identifies the time level member in the measure-based exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that customer dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SupplierLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the exception hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the product hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand class level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the cluster hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"integer",
            "description":"Value that uniquely identifies the basis in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the cluster hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the demand class dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlannerDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the measure-based exception detail.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the planner associated with the item in the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the resource hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the resource hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the time hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirstGeneratedDate":{
            "type":"string",
            "description":"Date when the exception details were first generated by plan.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the time dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the exception detail was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the scenario level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the product level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the measure-based exception detail.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer hierarchy level in the measure-based exception.",
            "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"
            }
        },
        "CustomerLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionAge":{
            "type":"integer",
            "description":"Number of days representing the age of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersistentId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the persistence exception detail in the measure-based exception detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the plan hierarchy name in themeasure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseMeasureQuantity":{
            "type":"number",
            "description":"Number that represents the measure value or quantity of the measure for comparison with threshold in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the order type hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Number that uniquely identifies an exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseMeasureDate":{
            "type":"string",
            "description":"Date represented as measure value for comparison with threshold in the measure-based exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the order type hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the product level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the resource dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExceptionHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the exception hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the product hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassLevelName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the demand class hierarchy level in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the resource level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the order type dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Basis":{
            "type":"integer",
            "description":"Basis of the exception computation. Default is Measure for a measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TimeHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the time hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScenarioLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the scenario hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionLevelMemberName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the exception level member in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "type":"integer",
            "description":"Contains information created or updated for an exception detail represented as notes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the scenario level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer hierarchy level in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the demand class hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the cluster dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionDimEnabled":{
            "type":"integer",
            "description":"Contains one of the following values: 1 or 2. If 1, then it indicates that the exception dimension is enabled for the measure-based exception. If 2, then the dimension isn't enabled. The default value is 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan in which exception is generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the product hierarchy in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClusterLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the cluster-level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Exception":{
            "title":"Exception",
            "maxLength":240,
            "type":"string",
            "description":"Name of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThresholdMeasureQuantity":{
            "type":"number",
            "description":"Number that represents the threshold value or quantity of the measure in the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerLevelMember":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer level member in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ThresholdMeasureDate":{
            "type":"string",
            "description":"Date represented as measure value for threshold in the measure-based exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeHierarchy":{
            "type":"integer",
            "description":"Value that uniquely identifies the order type hierarchy in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationHierarchyName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization hierarchy in the measure-based exception.",
            "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