Jump to

• Request
• Response

Get one exception set

get

/fscmRestApi/resources/11.13.18.05/exceptionSets/{ExceptionSetId}

Request

Path Parameters

• ExceptionSetId(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 : exceptionSets-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the exception set.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the exception set.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the exception set
• ExceptionCutoffDays: integer (int32)
  Title: Exception Cutoff Days

  Number of calendar days, starting from the plan start date, used to generate the exceptions.
• ExceptionSet: string
  Title: Exception Set

  Maximum Length: 80

  Name of the exception set.
• ExceptionSetId: integer (int64)
  Value that uniquely identifies the exception set.
• ExceptionSetsAssociation: array Exception Set Associations
  Title: Exception Set Associations

  The list of exceptions that are included in the exception set.
• Filters: array Filters
  Title: Filters

  Organizations, suppliers, item categories, and customers for which the exception set is applicable.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the exception set was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the exception set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the exception set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the exception set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the exception set",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionCutoffDays":{
            "title":"Exception Cutoff Days",
            "type":"integer",
            "description":"Number of calendar days, starting from the plan start date, used to generate the exceptions.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExceptionSet":{
            "title":"Exception Set",
            "maxLength":80,
            "type":"string",
            "description":"Name of the exception set.",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ExceptionSetsAssociation":{
            "title":"Exception Set Associations",
            "type":"array",
            "description":"The list of exceptions that are included in the exception set.",
            "items":{
                "$ref":"#/components/schemas/exceptionSets-ExceptionSetsAssociation-item-response"
            }
        },
        "Filters":{
            "title":"Filters",
            "type":"array",
            "description":"Organizations, suppliers, item categories, and customers for which the exception set is applicable.",
            "items":{
                "$ref":"#/components/schemas/exceptionSets-Filters-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the exception set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the exception set.",
            "nullable":false,
            "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 : Exception Set Associations

Type: array

Title: Exception Set Associations

The list of exceptions that are included in the exception set.

Show Source

• Array of: object exceptionSets-ExceptionSetsAssociation-item-response

{
    "title":"Exception Set Associations",
    "type":"array",
    "description":"The list of exceptions that are included in the exception set.",
    "items":{
        "$ref":"#/components/schemas/exceptionSets-ExceptionSetsAssociation-item-response"
    }
}

Nested Schema : Filters

Type: array

Title: Filters

Organizations, suppliers, item categories, and customers for which the exception set is applicable.

Show Source

• Array of: object exceptionSets-Filters-item-response

{
    "title":"Filters",
    "type":"array",
    "description":"Organizations, suppliers, item categories, and customers for which the exception set is applicable.",
    "items":{
        "$ref":"#/components/schemas/exceptionSets-Filters-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 : exceptionSets-ExceptionSetsAssociation-item-response

Type: object

Show Source

• Exception: string
  Maximum Length: 120

  Name of the exception.
• ExceptionId: integer (int64)
  Value that uniquely identifies the exception.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "Exception":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the exception.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception.",
            "format":"int64",
            "nullable":false,
            "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 : 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 : exceptionSets-Filters-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the exception set filter.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the exception set filter.
• FilterId: integer (int64)
  Value that uniquely identifies the filter.
• FilterType: integer (int64)
  Type of filter. Values can be ORGANIZATION, SUPPLIER, CATEGORY, or CUSTOMER.
• FilterValue: integer (int64)
  Value that uniquely identifies the filter based on its type. Depending on the FilterType, the value could be the organization ID, supplier ID, category ID, or customer ID.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the exception set filter was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the exception set filter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the exception set filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the exception set filter.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the filter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FilterType":{
            "type":"integer",
            "description":"Type of filter. Values can be ORGANIZATION, SUPPLIER, CATEGORY, or CUSTOMER.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FilterValue":{
            "type":"integer",
            "description":"Value that uniquely identifies the filter based on its type. Depending on the FilterType, the value could be the organization ID, supplier ID, category ID, or customer ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the exception set filter was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the exception set filter.",
            "nullable":false,
            "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

ExceptionSetsAssociation

Operation: /fscmRestApi/resources/11.13.18.05/exceptionSets/{ExceptionSetId}/child/ExceptionSetsAssociation

Parameters:

• ExceptionSetId: $request.path.ExceptionSetId

The list of exceptions that are included in the exception set.

Filters

Operation: /fscmRestApi/resources/11.13.18.05/exceptionSets/{ExceptionSetId}/child/Filters

Parameters:

• ExceptionSetId: $request.path.ExceptionSetId

Organizations, suppliers, item categories, and customers for which the exception set is applicable.

Back to Top