Jump to

• Request
• Response

Get one exception

get

/fscmRestApi/resources/11.13.18.05/configureExceptions/{ExceptionId}

Request

Path Parameters

• ExceptionId(required): integer(int64)
  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 : configureExceptions-item-response

Type: object

Show Source

• BaseMeasureDataType: integer (int32)
  Read Only: true

  Data type of the base measure of the measure-based exception.
• BaseMeasureDescription: string
  Read Only: true

  Maximum Length: 1000

  Description of the base measure of the measure-based exception.
• BaseMeasureGranularityId: integer (int64)
  Read Only: true

  Value of the granularity of base measure associated with the measure-based exception.
• BaseMeasureName: string
  Read Only: true

  Maximum Length: 250

  Name of the base measure associated with the measure-based exception.
• BasisType: string
  Title: Basis

  Read Only: true

  Maximum Length: 4000

  Value of the basis of the exception. Value can be an order or a measure.
• BasisTypeCode: integer
  Read Only: true

  Basis type code of the exception.
• BasisValue: integer (int64)
  Read Only: true

  Value of the basis of the exception. Value can be an order or a measure.
• ClusterDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that cluster dimension is enabled in the measure-based exception.
• ClusterHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the cluster hierarchy of the cluster dimension in the measure-based exception.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the exception.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  An indicator that the customer dimension is enabled in the measure-based exception.
• CustomerHierarchy: integer (int64)
  Read Only: true

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

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

  An indicator that the demand class dimension is enabled in the measure-based exception.
• DemandClassHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the demand class hierarchy of the demand class dimension in the measure-based exception.
• EndDemandOrderTypeDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the end demand order type dimension is enabled in the measure-based exception.
• EndDemandOrderTypeHierarchy: integer (int64)
  Read Only: true

  Name of the end demand order type hierarchy for the end demand order type dimension in the measure-based exception.
• EndDemandOrderTypeLevel: integer (int64)
  Read Only: true

  Name of the level for the end demand order type hierarchy of the end demand order type dimension in the measure-based exception.
• EndDemandOrganizationDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the end demand organization dimension is enabled in the measure-based exception.
• EndDemandOrganizationHierarchy: integer (int64)
  Read Only: true

  Name of the end demand organization hierarchy for the end demand organization dimension in the measure-based exception.
• EndDemandOrganizationLevel: integer (int64)
  Read Only: true

  Name of the level for the end demand organization hierarchy of the end demand organization dimension in the measure-based exception.
• EndDemandProductDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the end demand product dimension is enabled in the measure-based exception.
• EndDemandProductHierarchy: integer (int64)
  Read Only: true

  Name of the end demand product hierarchy for the end demand product dimension in the measure-based exception.
• EndDemandProductLevel: integer (int64)
  Read Only: true

  Name of the level for the end demand product hierarchy of the end demand product dimension in the measure-based exception.
• ExceptionDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the exception dimension is enabled in the measure-based exception.
• ExceptionDisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 120

  Display name of the exception.
• ExceptionGroups: array Exception Groups
  Title: Exception Groups

  Exception Groups
• ExceptionHierarchy: integer (int64)
  Read Only: true

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

  Value that uniquely identifies the exception.
• ExceptionLevel: integer (int64)
  Read Only: true

  Name of the level for the exception hierarchy of the exception dimension in the measure-based exception.
• ExceptionName: string
  Title: Exception

  Read Only: true

  Maximum Length: 120

  Name of the exception.
• ExceptionOperation: string
  Read Only: true

  Maximum Length: 32

  Operation for configuring the threshold of an exception.
• IncludeDependentMeasures: integer (int32)
  Read Only: true

  Indicates to include dependent measures in the exception configuration.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the user most recently updated the exception.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who performed the most recent update on the exception.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotesCount: number
  Title: Notes

  Read Only: true

  Number of notes associated with this exception.
• Notifications: array Notifications
  Title: Notifications

  Notifications
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the exception.
• OrderTypeDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the order type dimension is enabled in the measure-based exception.
• OrderTypeHierarchy: integer (int64)
  Read Only: true

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

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

  An indicator that the organization dimension is enabled in the measure-based exception.
• OrganizationHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the organization hierarchy of the organization dimension in the measure-based exception.
• PlanDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the plan dimension is enabled in the measure-based exception.
• PlanHierarchy: integer (int64)
  Read Only: true

  Name of the plan hierarchy for the plan dimension in the measure-based exception.
• PlanLevel: integer (int64)
  Read Only: true

  Name of the level for the plan hierarchy of the plan dimension in the measure-based exception.
• PlanType: integer (int32)
  Read Only: true

  Type of the plan associated with the exception.
• ProductDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that product dimension is enabled in the measure-based exception.
• ProductHierarchy: integer (int64)
  Read Only: true

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

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

  An indicator that the resource dimension is enabled in the measure-based exception.
• ResourceHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the resource hierarchy of the resource dimension in the measure-based exception.
• SalesOrganizationDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the sales organization dimension is enabled in the measure-based exception.
• SalesOrganizationHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the sales organization hierarchy of the sales organization dimension in the measure-based exception.
• ScenarioDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that scenario dimension is enabled in the measure-based exception.
• ScenarioHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the scenario hierarchy of the scenario dimension in the measure-based exception.
• SeededExceptionFlag: boolean
  Read Only: true

  Indicates an exception is seeded.
• SendNotification: integer (int32)
  Read Only: true

  Indicator to enable notification for a measure-based exception.
• SourceDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the source dimension is enabled in the measure-based exception.
• SourceHierarchy: integer (int64)
  Read Only: true

  Name of the source hierarchy for the source dimension in the measure-based exception.
• SourceLevel: integer (int64)
  Read Only: true

  Name of the level for the source hierarchy of the source dimension in the measure-based exception.
• SupplierDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that supplier dimension is enabled in the measure-based exception.
• SupplierHierarchy: integer (int64)
  Read Only: true

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

  Name of the level for the supplier hierarchy of the supplier dimension in the measure-based exception.
• Threshold: number
  Read Only: true

  Value of the threshold for the exception.
• ThresholdDate: string (date)
  Read Only: true

  Date of the threshold for the exception.
• ThresholdMeasureId: integer (int64)
  Read Only: true

  Value that uniquely identifies the threshold measure for the exception.
• ThresholdMeasureName: string
  Read Only: true

  Maximum Length: 250

  Name of the threshold measure for the exception.
• ThresholdType: integer (int32)
  Read Only: true

  Type of the threshold for the exception.
• TimeDimensionEnabled: integer (int32)
  Read Only: true

  An indicator that the time dimension is enabled in the measure-based exception.
• TimeHierarchy: integer (int64)
  Read Only: true

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

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

{
    "type":"object",
    "properties":{
        "BaseMeasureDataType":{
            "type":"integer",
            "description":"Data type of the base measure of the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "BaseMeasureDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the base measure of the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BaseMeasureGranularityId":{
            "type":"integer",
            "description":"Value of the granularity of base measure associated with the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseMeasureName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the base measure associated with the measure-based exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisType":{
            "title":"Basis",
            "maxLength":4000,
            "type":"string",
            "description":"Value of the basis of the exception. Value can be an order or a measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisTypeCode":{
            "type":"integer",
            "description":"Basis type code of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BasisValue":{
            "type":"integer",
            "description":"Value of the basis of the exception. Value can be an order or a measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that cluster dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ClusterHierarchy":{
            "type":"integer",
            "description":"Name of the cluster hierarchy for the cluster dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClusterLevel":{
            "type":"integer",
            "description":"Name of the level for the cluster hierarchy of the cluster dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the exception was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the customer dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CustomerHierarchy":{
            "type":"integer",
            "description":"Name of the customer hierarchy for the customer dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerLevel":{
            "type":"integer",
            "description":"Name of the level for the customer hierarchy of the customer dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the demand class dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DemandClassHierarchy":{
            "type":"integer",
            "description":"Name of the demand class hierarchy for the demand class dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandClassLevel":{
            "type":"integer",
            "description":"Name of the level for the demand class hierarchy of the demand class dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandOrderTypeDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the end demand order type dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndDemandOrderTypeHierarchy":{
            "type":"integer",
            "description":"Name of the end demand order type hierarchy for the end demand order type dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandOrderTypeLevel":{
            "type":"integer",
            "description":"Name of the level for the end demand order type hierarchy of the end demand order type dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandOrganizationDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the end demand organization dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndDemandOrganizationHierarchy":{
            "type":"integer",
            "description":"Name of the end demand organization hierarchy for the end demand organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandOrganizationLevel":{
            "type":"integer",
            "description":"Name of the level for the end demand organization hierarchy of the end demand organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandProductDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the end demand product dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndDemandProductHierarchy":{
            "type":"integer",
            "description":"Name of the end demand product hierarchy for the end demand product dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDemandProductLevel":{
            "type":"integer",
            "description":"Name of the level for the end demand product hierarchy of the end demand product dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the exception dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExceptionDisplayName":{
            "title":"Display Name",
            "maxLength":120,
            "type":"string",
            "description":"Display name of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionGroups":{
            "title":"Exception Groups",
            "type":"array",
            "description":"Exception Groups",
            "items":{
                "$ref":"#/components/schemas/configureExceptions-ExceptionGroups-item-response"
            }
        },
        "ExceptionHierarchy":{
            "type":"integer",
            "description":"Name of the exception hierarchy for the exception dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionLevel":{
            "type":"integer",
            "description":"Name of the level for the exception hierarchy of the exception dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionName":{
            "title":"Exception",
            "maxLength":120,
            "type":"string",
            "description":"Name of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionOperation":{
            "maxLength":32,
            "type":"string",
            "description":"Operation for configuring the threshold of an exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeDependentMeasures":{
            "type":"integer",
            "description":"Indicates to include dependent measures in the exception configuration.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the user most recently updated the exception.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who performed the most recent update on the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotesCount":{
            "title":"Notes",
            "type":"number",
            "description":"Number of notes associated with this exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notifications":{
            "title":"Notifications",
            "type":"array",
            "description":"Notifications",
            "items":{
                "$ref":"#/components/schemas/configureExceptions-Notifications-item-response"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrderTypeDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the order type dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrderTypeHierarchy":{
            "type":"integer",
            "description":"Name of the order type hierarchy for the order type dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderTypeLevel":{
            "type":"integer",
            "description":"Name of the level for the order type hierarchy of the order type dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the organization dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrganizationHierarchy":{
            "type":"integer",
            "description":"Name of the organization hierarchy for the organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationLevel":{
            "type":"integer",
            "description":"Name of the level for the organization hierarchy of the organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the plan dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanHierarchy":{
            "type":"integer",
            "description":"Name of the plan hierarchy for the plan dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanLevel":{
            "type":"integer",
            "description":"Name of the level for the plan hierarchy of the plan dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanType":{
            "type":"integer",
            "description":"Type of the plan associated with the exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProductDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that product dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProductHierarchy":{
            "type":"integer",
            "description":"Name of the product hierarchy for the product dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductLevel":{
            "type":"integer",
            "description":"Name of the level for the product hierarchy of the product dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the resource dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ResourceHierarchy":{
            "type":"integer",
            "description":"Name of the resource hierarchy for the resource dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceLevel":{
            "type":"integer",
            "description":"Name of the level for the resource hierarchy of the resource dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrganizationDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the sales organization dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SalesOrganizationHierarchy":{
            "type":"integer",
            "description":"Name of the sales organization hierarchy for the sales organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrganizationLevel":{
            "type":"integer",
            "description":"Name of the level for the sales organization hierarchy of the sales organization dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "ScenarioDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that scenario dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ScenarioHierarchy":{
            "type":"integer",
            "description":"Name of the scenario hierarchy for the scenario dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioLevel":{
            "type":"integer",
            "description":"Name of the level for the scenario hierarchy of the scenario dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SeededExceptionFlag":{
            "type":"boolean",
            "description":"Indicates an exception is seeded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SendNotification":{
            "type":"integer",
            "description":"Indicator to enable notification for a measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the source dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceHierarchy":{
            "type":"integer",
            "description":"Name of the source hierarchy for the source dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLevel":{
            "type":"integer",
            "description":"Name of the level for the source hierarchy of the source dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that supplier dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SupplierHierarchy":{
            "type":"integer",
            "description":"Name of the supplier hierarchy for the supplier dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierLevel":{
            "type":"integer",
            "description":"Name of the level for the supplier hierarchy of the supplier dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Threshold":{
            "type":"number",
            "description":"Value of the threshold for the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThresholdDate":{
            "type":"string",
            "description":"Date of the threshold for the exception.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThresholdMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the threshold measure for the exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ThresholdMeasureName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the threshold measure for the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ThresholdType":{
            "type":"integer",
            "description":"Type of the threshold for the exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TimeDimensionEnabled":{
            "type":"integer",
            "description":"An indicator that the time dimension is enabled in the measure-based exception.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TimeHierarchy":{
            "type":"integer",
            "description":"Name of the time hierarchy for the time dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeLevel":{
            "type":"integer",
            "description":"Name of the level for the time hierarchy of the time dimension in the measure-based exception.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Exception Groups

Type: array

Title: Exception Groups

Exception Groups

Show Source

• Array of: object configureExceptions-ExceptionGroups-item-response

{
    "title":"Exception Groups",
    "type":"array",
    "description":"Exception Groups",
    "items":{
        "$ref":"#/components/schemas/configureExceptions-ExceptionGroups-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 : Notifications

Type: array

Title: Notifications

Notifications

Show Source

• Array of: object configureExceptions-Notifications-item-response

{
    "title":"Notifications",
    "type":"array",
    "description":"Notifications",
    "items":{
        "$ref":"#/components/schemas/configureExceptions-Notifications-item-response"
    }
}

Nested Schema : configureExceptions-ExceptionGroups-item-response

Type: object

Show Source

• GroupDisplaySequence: integer (int64)
  Read Only: true

  Value that represents the display sequence of the exception group.
• GroupId: integer (int64)
  Read Only: true

  Value that uniquely represents the exception group.
• GroupName: string
  Title: Group

  Read Only: true

  Maximum Length: 80

  Name of the exception group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededGroupFlag: boolean
  Read Only: true

  An indicator that an exception group is seeded.

{
    "type":"object",
    "properties":{
        "GroupDisplaySequence":{
            "type":"integer",
            "description":"Value that represents the display sequence of the exception group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely represents the exception group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupName":{
            "title":"Group",
            "maxLength":80,
            "type":"string",
            "description":"Name of the exception group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededGroupFlag":{
            "type":"boolean",
            "description":"An indicator that an exception group is seeded.",
            "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."
        }
    }
}

Nested Schema : configureExceptions-Notifications-item-response

Type: object

Show Source

• ExceptionId: integer
  Read Only: true

  Value that uniquely identifies the exception.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationDetails: array Notification Details
  Title: Notification Details

  Notification Details
• NotificationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the notification.
• NotificationSettings: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the notification settings option selected for notification details.
• RecipientId: integer (int64)
  Read Only: true

  Value that uniquely identifies the recipient of the notification.
• RecipientName: string
  Read Only: true

  Maximum Length: 4000

  Name of the recipient of the notification.
• RecipientType: integer (int32)
  Read Only: true

  Type of the recipient of notification. Type can be a user or a role.

{
    "type":"object",
    "properties":{
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationDetails":{
            "title":"Notification Details",
            "type":"array",
            "description":"Notification Details",
            "items":{
                "$ref":"#/components/schemas/configureExceptions-Notifications-NotificationDetails-item-response"
            }
        },
        "NotificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the notification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotificationSettings":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the notification settings option selected for notification details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recipient of the notification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecipientName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the recipient of the notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientType":{
            "type":"integer",
            "description":"Type of the recipient of notification. Type can be a user or a role.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Notification Details

Type: array

Title: Notification Details

Notification Details

Show Source

• Array of: object configureExceptions-Notifications-NotificationDetails-item-response

{
    "title":"Notification Details",
    "type":"array",
    "description":"Notification Details",
    "items":{
        "$ref":"#/components/schemas/configureExceptions-Notifications-NotificationDetails-item-response"
    }
}

Nested Schema : configureExceptions-Notifications-NotificationDetails-item-response

Type: object

Show Source

• Condition: string
  Read Only: true

  Maximum Length: 255

  Name that represents the condition in the exception notification.
• Entity: string
  Read Only: true

  Maximum Length: 64

  Name that represents the entity in the exception notification.
• ExceptionId: integer
  Read Only: true

  Value that uniquely identifies the exception.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotificationCondition: string (byte)
  Read Only: true

  Name of the condition option selected in notification details.
• NotificationEntity: integer (int64)
  Read Only: true

  Name of the entity option selected in notification details.
• NotificationId: integer (int64)
  Read Only: true

  Value that uniquely identifies a notification in the notification detail.
• NotificationOperation: string
  Read Only: true

  Maximum Length: 32

  Name of the operation selected in the notification detail.
• Value: string
  Read Only: true

  Maximum Length: 255

  Value of the entity option selected in notification details.
• ValueIdentifier: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the entity option selected in notification details.

{
    "type":"object",
    "properties":{
        "Condition":{
            "maxLength":255,
            "type":"string",
            "description":"Name that represents the condition in the exception notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Entity":{
            "maxLength":64,
            "type":"string",
            "description":"Name that represents the entity in the exception notification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationCondition":{
            "type":"string",
            "description":"Name of the condition option selected in notification details.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NotificationEntity":{
            "type":"integer",
            "description":"Name of the entity option selected in notification details.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies a notification in the notification detail.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NotificationOperation":{
            "maxLength":32,
            "type":"string",
            "description":"Name of the operation selected in the notification detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Value":{
            "maxLength":255,
            "type":"string",
            "description":"Value of the entity option selected in notification details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueIdentifier":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the entity option selected in notification details.",
            "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"
    }
}

Links

ExceptionGroups

Operation: /fscmRestApi/resources/11.13.18.05/configureExceptions/{ExceptionId}/child/ExceptionGroups

Parameters:

• ExceptionId: $request.path.ExceptionId

Exception Groups

Notifications

Operation: /fscmRestApi/resources/11.13.18.05/configureExceptions/{ExceptionId}/child/Notifications

Parameters:

• ExceptionId: $request.path.ExceptionId

Notifications

Back to Top