Jump to

• Request
• Response

Get all fee associations

get

/fscmRestApi/resources/11.13.18.05/feeAssociations

Request

Query Parameters

• 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
  
  

  • AltKey Finds the fee association that matches the alternate key criteria specified.
    Finder Variables
    • FeeAssociationNameCode; string; Unique code identifier for the fee association.
  • ByKeywordFinder Finds all fee associations that match the specified keyword.
    Finder Variables
    • Keyword; string; The keyword for the fee association.
  • PrimaryKey Finds the fee association that matches the primary key criteria specified.
    Finder Variables
    • FeeAssociationId; integer; Unique identifier for the fee association.
• 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:
  

  • ActiveFlag; boolean; Indicates whether the fee association is active or inactive. The default value is true.
  • ArtifactGroupCode; string; The artifact group unique code.
  • ArtifactGroupId; integer; Data artifact group unique identifier.
  • ArtifactGroupName; string; The name of an artifact group.
  • AssociationTypeCode; string; Determines whether the fee association record is linked to an object or criteria.
  • AssociationTypeMeaning; string; Description of the association type.
  • AutomaticSubmitFlag; boolean; Indicates whether requests are automatically processed even when there are issues posting transactions to the user's account.
  • BusinessUnitId; integer; Unique identifier for a business unit associated with the fee association.
  • BusinessUnitName; string; Name of the business unit.
  • FeeAssociationDescription; string; Description of the fee association.
  • FeeAssociationGroupCode; string; Unique, user-defined code for the fee association group.
  • FeeAssociationGroupId; integer; Unique identifier for the fee association group.
  • FeeAssociationGroupName; string; Name of the fee association group.
  • FeeAssociationId; integer; Unique identifier for a fee association.
  • FeeAssociationName; string; Name of the fee association.
  • FeeAssociationNameCode; string; Unique, user-defined code for the fee association.
  • FeePostOptionCode; string; Indicates whether the fees should be posted to the student account or another location.
  • FeePostOptionMeaning; string; Meaning of the fee option code.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • PayNowFlag; boolean; Indicates whether the fees must be paid now or can be paid at a later time. The default value is true.
• 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 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 : feeAssociations

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/feeAssociations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"HED"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object feeAssociations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/feeAssociations-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 : feeAssociations-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the fee association is active or inactive. The default value is true.
• ArtifactGroupCode: string
  Title: Data Group Code

  Read Only: true

  Maximum Length: 50

  The artifact group unique code.
• ArtifactGroupId: integer (int64)
  Title: Data Group ID

  Read Only: true

  Data artifact group unique identifier.
• ArtifactGroupName: string
  Title: Data Group Name

  Read Only: true

  Maximum Length: 50

  The name of an artifact group.
• AssociationTypeCode: string
  Title: Association Type Code

  Maximum Length: 30

  Determines whether the fee association record is linked to an object or criteria.
• AssociationTypeMeaning: string
  Title: Association Type

  Read Only: true

  Maximum Length: 80

  Description of the association type.
• AutomaticSubmitFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether requests are automatically processed even when there are issues posting transactions to the user's account.
• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Unique identifier for a business unit associated with the fee association.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit.
• FeeAssociationDescription: string
  Title: Fee Association Description

  Maximum Length: 240

  Description of the fee association.
• feeAssociationFees: array Fee Association Fees
  Title: Fee Association Fees

  The fee association fees resource stores the fees used in a fee association.
• FeeAssociationGroupCode: string
  Title: Fee Association Group Code

  Maximum Length: 50

  Unique, user-defined code for the fee association group.
• FeeAssociationGroupId: integer (int64)
  Title: Fee Association Group ID

  Unique identifier for the fee association group.
• FeeAssociationGroupName: string
  Title: Fee Association Group Name

  Read Only: true

  Maximum Length: 50

  Name of the fee association group.
• FeeAssociationId: integer (int64)
  Title: Fee Association ID

  Read Only: true

  Unique identifier for a fee association.
• FeeAssociationName: string
  Title: Fee Association Name

  Maximum Length: 50

  Name of the fee association.
• FeeAssociationNameCode: string
  Title: Fee Association Name Code

  Maximum Length: 50

  Unique, user-defined code for the fee association.
• feeAssociationObjects: array Fee Associations Object
  Title: Fee Associations Object

  Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.
• FeePostOptionCode: string
  Title: Fee Post Option Code

  Maximum Length: 30

  Indicates whether the fees should be posted to the student account or another location.
• FeePostOptionMeaning: string
  Title: Fee Post Option

  Read Only: true

  Maximum Length: 80

  Meaning of the fee option code.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayNowFlag: boolean
  Title: Require immediate payment

  Maximum Length: 1

  Default Value: true

  Indicates whether the fees must be paid now or can be paid at a later time. The default value is true.

{
    "type":"object",
    "properties":{
        "FeeAssociationId":{
            "title":"Fee Association ID",
            "type":"integer",
            "description":"Unique identifier for a fee association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FeeAssociationGroupId":{
            "title":"Fee Association Group ID",
            "type":"integer",
            "description":"Unique identifier for the fee association group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FeeAssociationGroupCode"
                ]
            },
            "x-queryable":true
        },
        "FeeAssociationGroupName":{
            "title":"Fee Association Group Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee association group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAssociationDescription":{
            "title":"Fee Association Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the fee association.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AutomaticSubmitFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether requests are automatically processed even when there are issues posting transactions to the user's account.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ArtifactGroupCode":{
            "title":"Data Group Code",
            "maxLength":"50",
            "type":"string",
            "description":"The artifact group unique code.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeePostOptionMeaning":{
            "title":"Fee Post Option",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the fee option code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for a business unit associated with the fee association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "BusinessUnitName"
                ]
            },
            "x-queryable":true
        },
        "FeeAssociationName":{
            "title":"Fee Association Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee association.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "feeAssociationObjects":{
            "title":"Fee Associations Object",
            "type":"array",
            "description":"Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.",
            "items":{
                "$ref":"#/components/schemas/feeAssociations-feeAssociationObjects-item-response"
            }
        },
        "AssociationTypeMeaning":{
            "title":"Association Type",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the association type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the fee association is active or inactive. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeePostOptionCode":{
            "title":"Fee Post Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the fees should be posted to the student account or another location.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "feeAssociationFees":{
            "title":"Fee Association Fees",
            "type":"array",
            "description":"The fee association fees resource stores the fees used in a fee association.",
            "items":{
                "$ref":"#/components/schemas/feeAssociations-feeAssociationFees-item-response"
            }
        },
        "FeeAssociationNameCode":{
            "title":"Fee Association Name Code",
            "maxLength":"50",
            "type":"string",
            "description":"Unique, user-defined code for the fee association.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ArtifactGroupId":{
            "title":"Data Group ID",
            "type":"integer",
            "description":"Data artifact group unique identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "ArtifactGroupCode"
                ]
            },
            "x-queryable":true
        },
        "FeeAssociationGroupCode":{
            "title":"Fee Association Group Code",
            "maxLength":"50",
            "type":"string",
            "description":"Unique, user-defined code for the fee association group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayNowFlag":{
            "title":"Require immediate payment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the fees must be paid now or can be paid at a later time. The default value is true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AssociationTypeCode":{
            "title":"Association Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Determines whether the fee association record is linked to an object or criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ArtifactGroupName":{
            "title":"Data Group Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an artifact group.",
            "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"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Fee Association Fees

Type: array

Title: Fee Association Fees

The fee association fees resource stores the fees used in a fee association.

Show Source

• Array of: object feeAssociations-feeAssociationFees-item-response

{
    "title":"Fee Association Fees",
    "type":"array",
    "description":"The fee association fees resource stores the fees used in a fee association.",
    "items":{
        "$ref":"#/components/schemas/feeAssociations-feeAssociationFees-item-response"
    }
}

Nested Schema : Fee Associations Object

Type: array

Title: Fee Associations Object

Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.

Show Source

• Array of: object feeAssociations-feeAssociationObjects-item-response

{
    "title":"Fee Associations Object",
    "type":"array",
    "description":"Fee association objects store information about objects like courses, programs, forms, transcripts, and so on, that are mapped to the fee association.",
    "items":{
        "$ref":"#/components/schemas/feeAssociations-feeAssociationObjects-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 : feeAssociations-feeAssociationFees-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "FeeName":{
            "title":"Fee Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeeTypeName":{
            "title":"Fee Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"Name of the fee type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "feeAssociationAttributes":{
            "title":"Fee Association Attributes",
            "type":"array",
            "description":"The fee association attributes resource stores the attributes used for a fee in a fee association.",
            "items":{
                "$ref":"#/components/schemas/feeAssociations-feeAssociationFees-feeAssociationAttributes-item-response"
            }
        },
        "FeeId":{
            "title":"Fee ID",
            "type":"integer",
            "description":"Unique identifier for the fee being associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FeeName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeTypeId":{
            "title":"Fee Type ID",
            "type":"integer",
            "description":"Unique identifier for a fee type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "FeeTypeName"
                ]
            },
            "x-queryable":true
        },
        "FeeAssociationFeeId":{
            "title":"Fee Association Fee ID",
            "type":"integer",
            "description":"Unique identifier for a fee in a fee association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object feeAssociations-feeAssociationFees-feeAssociationAttributes-item-response

{
    "title":"Fee Association Attributes",
    "type":"array",
    "description":"The fee association attributes resource stores the attributes used for a fee in a fee association.",
    "items":{
        "$ref":"#/components/schemas/feeAssociations-feeAssociationFees-feeAssociationAttributes-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 : feeAssociations-feeAssociationFees-feeAssociationAttributes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LovSourceResourceName":{
            "title":"List of Values Source Resource Name",
            "maxLength":"200",
            "type":"string",
            "description":"The source resource name for the list of values resource of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":"512",
            "type":"string",
            "description":"Value of the data artifact element attribute.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Attribute Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a data artifact element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumInRange":{
            "title":"Minimum Value",
            "type":"integer",
            "description":"The minimum value of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"Unique identifier for a data artifact element attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LookupTypeCode":{
            "title":"List of Values Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The list of values lookup type of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAttributeIdTwo":{
            "title":"Parent Attribute 2 ID",
            "type":"integer",
            "description":"The parent attribute 2 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LovDisplayFields":{
            "title":"List of Values Display Fields",
            "maxLength":"900",
            "type":"string",
            "description":"The comma-separated field names of the list of values resource associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TranslatableFlag":{
            "title":"Translatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is translatable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDataTypeCode":{
            "title":"Data Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCodeAlias":{
            "title":"Attribute Alias",
            "maxLength":"500",
            "type":"string",
            "description":"The alias of the element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinderAttributeNameOne":{
            "title":"Finder 1 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 1 of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":"512",
            "type":"string",
            "description":"The default value of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LovValueField":{
            "title":"List of Values Field",
            "maxLength":"900",
            "type":"string",
            "description":"The field name of the list of values resource associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QueryableFlag":{
            "title":"Can Be Queried",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute can be queried.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LovFinderName":{
            "title":"List of Values Finder Name",
            "maxLength":"512",
            "type":"string",
            "description":"The list of values finder name of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowLovMultipleFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowLovAllFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the value All appears in the list of values for the association criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the data artifact element attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeTypeMeaning":{
            "title":"Data Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the element attribute data type code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAllValuesFlag":{
            "title":"Use All Values",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether all attribute values or a specific attribute value is used.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "AttributeSequence":{
            "title":"Attribute Sequence",
            "type":"integer",
            "description":"The sequence of the attribute in the element.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "MaximumInRange":{
            "title":"Maximum Value",
            "type":"integer",
            "description":"The maximum value of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAttributeIdThree":{
            "title":"Parent Attribute 3 ID",
            "type":"integer",
            "description":"The parent attribute 3 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LovArtifactId":{
            "title":"List of Values Resource ID",
            "type":"integer",
            "description":"The list of values resource ID of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeWeight":{
            "title":"Weight",
            "type":"number",
            "description":"The importance of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5",
                "scale":"4"
            },
            "x-queryable":true
        },
        "ParentAttributeIdFour":{
            "title":"Parent Attribute 4 ID",
            "type":"integer",
            "description":"The parent attribute 4 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAttributeIdFive":{
            "title":"Parent Attribute 5 ID",
            "type":"integer",
            "description":"The parent attribute 5 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeRowNumber":{
            "title":"Attribute Row Number",
            "type":"integer",
            "description":"Row number of the attribute in relation to other attributes.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeeAssociationAttributeId":{
            "title":"Fee Association Attribute ID",
            "type":"integer",
            "description":"Unique identifier for a fee attribute used in the fee association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParentAttributeIdOne":{
            "title":"Parent Attribute 1 ID",
            "type":"integer",
            "description":"The parent attribute 1 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameFour":{
            "title":"Finder 4 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 4 of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeLength":{
            "title":"Attribute Length",
            "type":"integer",
            "description":"The length of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameThree":{
            "title":"Finder 3 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 3 of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":"50",
            "type":"string",
            "description":"The data artifact element attribute unique code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatableFlag":{
            "title":"Updatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is updatable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowChangesTypeCode":{
            "title":"Allow Changes",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates when an element attribute is updatable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDecimalPlaces":{
            "title":"Decimal Places",
            "type":"integer",
            "description":"The precision of an element attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameFive":{
            "title":"Finder 5 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 5 of an element attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryObjectFlag":{
            "title":"Primary Object",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates when an element attribute is primary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinderAttributeNameTwo":{
            "title":"Finder 2 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 2 of an element attribute.",
            "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."
        }
    }
}

Nested Schema : feeAssociations-feeAssociationObjects-item-response

Type: object

Show Source

• FeeAssociationObjectId: integer (int64)
  Read Only: true

  Unique identifier of the object mapped to the fee association.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Maximum Length: 100

  Code of the object mapped to the fee association.

{
    "type":"object",
    "properties":{
        "ObjectCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Code of the object mapped to the fee association.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeAssociationObjectId":{
            "type":"integer",
            "description":"Unique identifier of the object mapped to the fee association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Back to Top