Get all fee association fees
get
/fscmRestApi/resources/11.13.18.05/feeAssociations/{FeeAssociationId}/child/feeAssociationFees
Request
Path Parameters
-
FeeAssociationId(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 -
finder: string
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 fee association fee that matches the primary key criteria specified.
Finder Variables- FeeAssociationFeeId; integer; Unique identifier for a fee in a fee association.
- PrimaryKey Finds the fee association fee that matches the primary key criteria specified.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- FeeAssociationFeeId; integer; Unique identifier for a fee in a fee association.
- FeeId; integer; Unique identifier for the fee being associated.
- FeeName; string; Name of the fee.
- FeeTypeId; integer; Unique identifier for a fee type.
- FeeTypeName; string; Name of the fee type.
-
totalResults: boolean
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
-
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 TopResponse
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.
Root Schema : feeAssociations-feeAssociationFees
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feeAssociations-feeAssociationFees-item-response
Type:
Show Source
object
-
feeAssociationAttributes: array
Fee Association Attributes
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association. -
FeeAssociationFeeId: integer
(int64)
Title:
Fee Association Fee ID
Read Only:true
Unique identifier for a fee in a fee association. -
FeeId: integer
(int64)
Title:
Fee ID
Unique identifier for the fee being associated. -
FeeName: string
Title:
Fee Name
Maximum Length:50
Name of the fee. -
FeeTypeId: integer
(int64)
Title:
Fee Type ID
Read Only:true
Unique identifier for a fee type. -
FeeTypeName: string
Title:
Fee Type Name
Read Only:true
Maximum Length:50
Name of the fee type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Fee Association Attributes
Type:
array
Title:
Fee Association Attributes
The fee association attributes resource stores the attributes used for a fee in a fee association.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feeAssociations-feeAssociationFees-feeAssociationAttributes-item-response
Type:
Show Source
object
-
AllowChangesTypeCode: string
Title:
Allow Changes
Read Only:true
Maximum Length:30
Indicates when an element attribute is updatable. -
AllowLovAllFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, the value All appears in the list of values for the association criteria. -
AllowLovMultipleFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, multiple values can be selected from the list of values for the association criteria. -
AttributeCode: string
Title:
Attribute Code
Read Only:true
Maximum Length:50
The data artifact element attribute unique code. -
AttributeCodeAlias: string
Title:
Attribute Alias
Read Only:true
Maximum Length:500
The alias of the element attribute. -
AttributeDataTypeCode: string
Title:
Data Type Code
Read Only:true
Maximum Length:30
The type of the data artifact element attribute, for example, integer or string. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeDecimalPlaces: integer
(int64)
Title:
Decimal Places
Read Only:true
The precision of an element attribute. -
AttributeId: integer
(int64)
Title:
Attribute ID
Unique identifier for a data artifact element attribute. -
AttributeLength: integer
(int64)
Title:
Attribute Length
Read Only:true
The length of an element attribute. -
AttributeName: string
Title:
Attribute Name
Read Only:true
Maximum Length:50
The name of the data artifact element attribute. -
AttributeRowNumber: integer
(int32)
Title:
Attribute Row Number
Row number of the attribute in relation to other attributes. -
AttributeSequence: integer
(int32)
Title:
Attribute Sequence
Read Only:true
The sequence of the attribute in the element. -
AttributeTypeMeaning: string
Title:
Data Type
Read Only:true
Maximum Length:80
The meaning of the element attribute data type code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:512
Value of the data artifact element attribute. -
AttributeWeight: number
Title:
Weight
Read Only:true
The importance of an element attribute. -
DefaultValue: string
Title:
Default Value
Read Only:true
Maximum Length:512
The default value of an element attribute. -
Description: string
Title:
Attribute Description
Read Only:true
Maximum Length:240
The description of a data artifact element attribute. -
FeeAssociationAttributeId: integer
(int64)
Title:
Fee Association Attribute ID
Read Only:true
Unique identifier for a fee attribute used in the fee association. -
FinderAttributeNameFive: string
Title:
Finder 5 Name
Read Only:true
Maximum Length:512
The finder name 5 of an element attribute. -
FinderAttributeNameFour: string
Title:
Finder 4 Name
Read Only:true
Maximum Length:512
The finder name 4 of an element attribute. -
FinderAttributeNameOne: string
Title:
Finder 1 Name
Read Only:true
Maximum Length:512
The finder name 1 of an element attribute. -
FinderAttributeNameThree: string
Title:
Finder 3 Name
Read Only:true
Maximum Length:512
The finder name 3 of an element attribute. -
FinderAttributeNameTwo: string
Title:
Finder 2 Name
Read Only:true
Maximum Length:512
The finder name 2 of an element attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup Type
Read Only:true
Maximum Length:30
The list of values lookup type of an element attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values Resource ID
Read Only:true
The list of values resource ID of an element attribute. -
LovDisplayFields: string
Title:
List of Values Display Fields
Read Only:true
Maximum Length:900
The comma-separated field names of the list of values resource associated with this attribute. -
LovFinderName: string
Title:
List of Values Finder Name
Read Only:true
Maximum Length:512
The list of values finder name of an element attribute. -
LovSourceResourceName: string
Title:
List of Values Source Resource Name
Read Only:true
Maximum Length:200
The source resource name for the list of values resource of an element attribute. -
LovValueField: string
Title:
List of Values Field
Read Only:true
Maximum Length:900
The field name of the list of values resource associated with this attribute. -
MaximumInRange: integer
(int64)
Title:
Maximum Value
Read Only:true
The maximum value of an element attribute. -
MinimumInRange: integer
(int64)
Title:
Minimum Value
Read Only:true
The minimum value of an element attribute. -
ParentAttributeIdFive: integer
(int64)
Title:
Parent Attribute 5 ID
Read Only:true
The parent attribute 5 of an element attribute. -
ParentAttributeIdFour: integer
(int64)
Title:
Parent Attribute 4 ID
Read Only:true
The parent attribute 4 of an element attribute. -
ParentAttributeIdOne: integer
(int64)
Title:
Parent Attribute 1 ID
Read Only:true
The parent attribute 1 of an element attribute. -
ParentAttributeIdThree: integer
(int64)
Title:
Parent Attribute 3 ID
Read Only:true
The parent attribute 3 of an element attribute. -
ParentAttributeIdTwo: integer
(int64)
Title:
Parent Attribute 2 ID
Read Only:true
The parent attribute 2 of an element attribute. -
PrimaryObjectFlag: boolean
Title:
Primary Object
Read Only:true
Maximum Length:1
Indicates when an element attribute is primary. -
QueryableFlag: boolean
Title:
Can Be Queried
Read Only:true
Maximum Length:1
Indicates whether an element attribute can be queried. -
RequiredFlag: boolean
Title:
Required
Read Only:true
Maximum Length:1
Indicates whether an element attribute is required. -
SourceObjectName: string
Title:
Source Object Name
Read Only:true
Maximum Length:200
The name of the attribute in the source object that's represented by this element, such as the REST resource attribute name or the view object attribute name. -
TranslatableFlag: boolean
Title:
Translatable
Read Only:true
Maximum Length:1
Indicates whether an element attribute is translatable. -
UpdatableFlag: boolean
Title:
Updatable
Read Only:true
Maximum Length:1
Indicates whether an element attribute is updatable. -
UseAllValuesFlag: boolean
Title:
Use All Values
Maximum Length:1
Indicates whether all attribute values or a specific attribute value is used.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.