Jump to

• Request
• Response

Get all financial mapping attributes

get

/fscmRestApi/resources/11.13.18.05/financialMappingAttributes

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
  
  

  • PrimaryKey Finds the financial mapping that matches the primary key criteria specified.
    Finder Variables
    • MappingAttributeId; integer; The unique identifier of the financial mapping attribute.
• 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:
  

  • BusinessUnitId; integer; Unique identifier of the business unit.
  • BusinessUnitName; string; Name of the business unit.
  • CurrencyCode; string; The currency code of the amount allowed on the mapping attribute.
  • CurrencySymbol; string; The currency symbol of the amount allowed on the mapping attribute.
  • CurrentPeriodGrantAmount; number; Amount allowed to be applied during the current period.
  • CurrentPeriodGrantCode; string; Unique code for the current period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • CurrentPeriodGrantMeaning; string; Name of the current period.
  • DefaultFlag; boolean; Indicates that the specific mapping attribute is the default.
  • FuturePeriodGrantAmount; number; Amount allowed to be applied during the future period.
  • FuturePeriodGrantCode; string; Unique code for the future period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • FuturePeriodGrantMeaning; string; Name of the future period.
  • MappingAttributeCode; string; Unique user-defined code of the mapping attribute.
  • MappingAttributeId; integer; Unique identifier of the mapping attribute.
  • MappingAttributeName; string; Unique user-defined name of the mapping attribute.
  • PriorPeriodGrantAmount; number; Amount allowed to be applied during the prior period.
  • PriorPeriodGrantCode; string; Unique code for the prior period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • PriorPeriodGrantMeaning; string; Name of the prior period.
  • PriorYearGrantAmount; number; Amount allowed to be applied during the prior year.
  • PriorYearGrantCode; string; Unique code for the prior year type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
  • PriorYearGrantMeaning; string; Name of the prior year.
• 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 : financialMappingAttributes

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/financialMappingAttributes-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 financialMappingAttributes-item-response

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

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Unique identifier of the business unit.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 15

  The currency code of the amount allowed on the mapping attribute.
• CurrencySymbol: string
  Title: Symbol

  Read Only: true

  Maximum Length: 12

  The currency symbol of the amount allowed on the mapping attribute.
• CurrentPeriodGrantAmount: number
  Amount allowed to be applied during the current period.
• CurrentPeriodGrantCode: string
  Maximum Length: 30

  Unique code for the current period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
• CurrentPeriodGrantMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the current period.
• DefaultFlag: boolean
  Maximum Length: 1

  Indicates that the specific mapping attribute is the default.
• FuturePeriodGrantAmount: number
  Amount allowed to be applied during the future period.
• FuturePeriodGrantCode: string
  Maximum Length: 30

  Unique code for the future period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
• FuturePeriodGrantMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the future period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingAttributeCode: string
  Maximum Length: 30

  Unique user-defined code of the mapping attribute.
• MappingAttributeId: integer (int64)
  Read Only: true

  Unique identifier of the mapping attribute.
• MappingAttributeName: string
  Maximum Length: 50

  Unique user-defined name of the mapping attribute.
• PriorPeriodGrantAmount: number
  Amount allowed to be applied during the prior period.
• PriorPeriodGrantCode: string
  Maximum Length: 30

  Unique code for the prior period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
• PriorPeriodGrantMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the prior period.
• PriorYearGrantAmount: number
  Amount allowed to be applied during the prior year.
• PriorYearGrantCode: string
  Maximum Length: 30

  Unique code for the prior year type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.
• PriorYearGrantMeaning: string
  Read Only: true

  Maximum Length: 80

  Name of the prior year.

{
    "type":"object",
    "properties":{
        "PriorPeriodGrantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique code for the prior period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PriorYearGrantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique code for the prior year type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FuturePeriodGrantMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the future period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "FuturePeriodGrantCode"
                ]
            },
            "x-queryable":true
        },
        "MappingAttributeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique user-defined code of the mapping attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PriorPeriodGrantMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the prior period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PriorPeriodGrantCode"
                ]
            },
            "x-queryable":true
        },
        "MappingAttributeName":{
            "maxLength":"50",
            "type":"string",
            "description":"Unique user-defined name of the mapping attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Symbol",
            "maxLength":"12",
            "type":"string",
            "description":"The currency symbol of the amount allowed on the mapping attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorPeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the prior period.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the amount allowed on the mapping attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentPeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the current period.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingAttributeId":{
            "type":"integer",
            "description":"Unique identifier of the mapping attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FuturePeriodGrantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique code for the future period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FuturePeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the future period.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the specific mapping attribute is the default.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrentPeriodGrantMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the current period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrentPeriodGrantCode"
                ]
            },
            "x-queryable":true
        },
        "PriorYearGrantMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the prior year.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PriorYearGrantCode"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrentPeriodGrantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique code for the current period type. A list of accepted values is defined in the lookup type ORA_HES_PERIOD_TYPE. Review and update the list of values in the Setup and Maintenance work area, Manage Student Management Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PriorYearGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the prior year.",
            "nullable":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."
        }
    }
}

Back to Top