Jump to

• Request
• Response

Create an exception set

post

/fscmRestApi/resources/11.13.18.05/exceptionSets

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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(required): 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.

{
    "required":[
        "ExceptionSet"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the exception set",
            "nullable":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
            }
        },
        "ExceptionSet":{
            "title":"Exception Set",
            "maxLength":80,
            "type":"string",
            "description":"Name of the exception set.",
            "nullable":false
        },
        "ExceptionSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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-post-request"
            }
        },
        "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-post-request"
            }
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : exceptionSets-ExceptionSetsAssociation-item-post-request

Type: object

Show Source

• Exception: string
  Maximum Length: 120

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

{
    "type":"object",
    "properties":{
        "Exception":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the exception.",
            "nullable":true
        },
        "ExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : exceptionSets-Filters-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "FilterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the filter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FilterType":{
            "type":"integer",
            "description":"Type of filter. Values can be ORGANIZATION, SUPPLIER, CATEGORY, or CUSTOMER.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        }
    }
}

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