1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Federal Attribute Supplemental Rules
  4. Federal Attribute Supplemental Rule Lines
  5. Federal Attribute Supplemental Rule Exception Messages

Get all federal attribute supplemental rule exception messages

get

/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines/{SupplRuleLineId}/child/fedAttributeSupplementalRuleExceptionMessages

Request

Path Parameters
  • 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=
  • 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
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the federal attribute supplemental rule exception message that matches the specified primary key criteria.
      Finder Variables
      • ExceptionUniqueId; integer; The unique identifier of the federal attribute supplemental rule exception message.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Code; string; Code of the federal attribute supplemental rule exception message.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • Description; string; Description of the federal attribute supplemental rule exception message.
    • ExceptionUniqueId; integer; The unique identifier of the federal attribute supplemental rule exception message.
    • JobId; integer; The unique identifier of the job associated with the federal attribute supplemental rule exception message.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • ParentTableUniqueId; integer; The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.
    • ProcessName; string; Name of the process associated with the federal attribute supplemental rule exception message.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response
Type: object
Show Source
  • Title: Exception Code
    Maximum Length: 30
    Code of the federal attribute supplemental rule exception message.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Exception Text
    Maximum Length: 4000
    Description of the federal attribute supplemental rule exception message.
  • Title: Exception Unique Id
    The unique identifier of the federal attribute supplemental rule exception message.
  • Title: Job Id
    The unique identifier of the job associated with the federal attribute supplemental rule exception message.
  • Title: Last Update Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Parent Table Unique Id
    The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.
  • Title: Process Name
    Maximum Length: 150
    Name of the process associated with the federal attribute supplemental rule exception message.
Back to Top

Examples

The following example shows how to retrieve all federal attribute supplemental rule exception messages by submitting a GET request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines/{SupplRuleLineId}/child/fedAttributeSupplementalRuleExceptionMessages

Response Body Example

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "Code": "OVERLAPPINGLINES",
            "Description": "The segment values overlap with supplemental rule line 300100586352375.",
            "ParentTableUniqueId": 300100586585111,
            "ProcessName": "Validate overlapping lines",
            "JobId": 300100586097657
        },
        {
            "Code": "OVERLAPPINGLINES",
            "Description": "The segment values overlap with supplemental rule line 300100586352373.",
            "ParentTableUniqueId": 300100586585110,
            "ProcessName": "Validate overlapping lines",
            "JobId": 300100586097657
        }
    ]
}
Back to Top