Jump to

• Request
• Response

Update a financial mapping attribute

patch

/fscmRestApi/resources/11.13.18.05/financialMappingAttributes/{MappingAttributeId}

Request

Path Parameters

• MappingAttributeId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrentPeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the current period.",
            "nullable":true
        },
        "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"
            }
        },
        "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"
            }
        },
        "FuturePeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the future period.",
            "nullable":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"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the specific mapping attribute is the default.",
            "nullable":false
        },
        "MappingAttributeName":{
            "maxLength":50,
            "type":"string",
            "description":"Unique user-defined name of the mapping attribute.",
            "nullable":false
        },
        "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"
            }
        },
        "PriorYearGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the prior year.",
            "nullable":true
        },
        "PriorPeriodGrantAmount":{
            "type":"number",
            "description":"Amount allowed to be applied during the prior period.",
            "nullable":true
        }
    }
}

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-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."
        }
    }
}

Links

periodGrantCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_PERIOD_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: FuturePeriodGrantCode; Target Attribute: LookupCode
• Display Attribute: Meaning

studentFinancialSystemConfigurationsLOV

Operation: /fscmRestApi/resources/11.13.18.05/studentFinancialSystemConfigurationsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

Back to Top