Jump to

• Request
• Response

Get a federal attribute supplemental rule line

get

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

Request

Path Parameters

• SupplRuleHeaderId(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=
• SupplRuleLineId(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:
  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.

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(required):
  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(required):
  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-item-response

Type: object

Show Source

• Allocate: string
  Title: Allocate

  Read Only: true

  Maximum Length: 255

  Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  A brief description of the reporting code associated with the federal supplemental rule line.
• fedAttributeSupplementalRuleFilters: array Federal Attribute Supplemental Rule Line Filters
  Title: Federal Attribute Supplemental Rule Line Filters

  The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.
• FromPeriod: string
  Title: From Period

  Maximum Length: 15

  Name of the starting period associated with the federal supplemental rule line.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The user login that last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReportingCodeValue: string
  Title: Reporting Code

  Maximum Length: 255

  Reporting code value of the federal attribute supplemental rule line.
• SupplRuleLineId: integer (int64)
  Title: Supplemental Rule Line ID

  The unique identifier of the federal attribute supplemental rule line.
• ToPeriod: string
  Title: To Period

  Maximum Length: 15

  Name of the ending period associated with the federal account attribute line.
• ValidationStatus: string
  Title: Validation Status

  Read Only: true

  Maximum Length: 255

  Validation status of the federal attribute supplemental rule line.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ToPeriod":{
            "title":"To Period",
            "maxLength":15,
            "type":"string",
            "description":"Name of the ending period associated with the federal account attribute line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the reporting code associated with the federal supplemental rule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplRuleLineId":{
            "title":"Supplemental Rule Line ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FromPeriod":{
            "title":"From Period",
            "maxLength":15,
            "type":"string",
            "description":"Name of the starting period associated with the federal supplemental rule line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":255,
            "type":"string",
            "description":"Validation status of the federal attribute supplemental rule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportingCodeValue":{
            "title":"Reporting Code",
            "maxLength":255,
            "type":"string",
            "description":"Reporting code value of the federal attribute supplemental rule line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "fedAttributeSupplementalRuleFilters":{
            "title":"Federal Attribute Supplemental Rule Line Filters",
            "type":"array",
            "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response"
            }
        },
        "Allocate":{
            "title":"Allocate",
            "maxLength":255,
            "type":"string",
            "description":"Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The user login that last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Federal Attribute Supplemental Rule Line Filters

Type: array

Title: Federal Attribute Supplemental Rule Line Filters

The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response

{
    "title":"Federal Attribute Supplemental Rule Line Filters",
    "type":"array",
    "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response

Type: object

Show Source

• AccountingSegment: string
  Title: Accounting Segment

  Maximum Length: 30

  Accounting segment of the federal attribute supplemental rule filter.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• HighValue: string
  Title: High Value

  Maximum Length: 25

  High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the record was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowValue: string
  Title: Low Value

  Maximum Length: 25

  Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator of the federal attribute supplemental rule filter.
• SupplRuleFilterId: integer (int64)
  Title: Supplemental Rule Filter ID

  The unique identifier of the federal attribute supplemental rule filter.
• Value: string
  Title: Value

  Maximum Length: 25

  Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":255,
            "type":"string",
            "description":"Operator of the federal attribute supplemental rule filter.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorLookupCode",
                    "OperatorMeaning"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HighValue":{
            "title":"High Value",
            "maxLength":25,
            "type":"string",
            "description":"High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplRuleFilterId":{
            "title":"Supplemental Rule Filter ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule filter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Value",
            "maxLength":25,
            "type":"string",
            "description":"Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountingSegment":{
            "title":"Accounting Segment",
            "maxLength":30,
            "type":"string",
            "description":"Accounting segment of the federal attribute supplemental rule filter.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            },
            "x-queryable":true
        },
        "LowValue":{
            "title":"Low Value",
            "maxLength":25,
            "type":"string",
            "description":"Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

fedAttributeSupplementalRuleFilters

Operation: /fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines/{SupplRuleLineId}/child/fedAttributeSupplementalRuleFilters

Parameters:

• SupplRuleHeaderId: $request.path.SupplRuleHeaderId
• SupplRuleLineId: $request.path.SupplRuleLineId

The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.

Back to Top