1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Expense Profile Attributes

Get all records of a person's expense profile attributes

get

/fscmRestApi/resources/11.13.18.05/expenseProfileAttributes

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • findByPerson: Finds the person's profile attributes record using the person identifier that matches the primary key criteria specified.
      Finder Variables:
      • PersonId; string; Identifier of the person associated with a profile attributes record.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AccountAccess; string; Access to account-related attributes by a user.
    • BUName; string; Name of a person's business unit.
    • BusinessUnitId; integer; Unique identifier of a person's business unit.
    • CompanySegment; string; Accounting segment that denotes a person's company.
    • CostCenterSegment; string; Accounting segment that denotes a person's cost center.
    • CurrencyCode; string; Code that is associated with the currency that is used for entering an expense.
    • CurrencyName; string; Name of the currency that is used for entering an expense.
    • DefaultExpenseAccountId; integer; Unique identifier of a person's default expense account.
    • DisableCcMerchantNameFlag; boolean; Indicates whether the user can modify merchant name of a credit card expense.
    • DisableCompanySegment; string; Toggle for the display of the company accounting segment on the mobile application.
    • DisableScanFlag; boolean; Indicates whether the scan feature is disabled on the mobile application.
    • EnableAttachments; string; Enables a user to attach required documents during expense entry.
    • EnableProjectFieldsFlag; boolean; Indicates whether project-related fields are enabled in the application.
    • EnableReimbCurrencyFlag; boolean; Indicates whether the reimbursement currency can be updated by the user.
    • EnableSavePasswordFlag; boolean; Indicates whether the user can save a password on the Expenses Mobile application.
    • ExpenseAccess; string; Access to Expenses by a user.
    • ExpenseEntryFlag; boolean; Indicates whether a user can enter expenses.
    • ExpenseTemplateId; string; Unique identifier of an expense template.
    • GoogleMapsAPIKey; string; API key for Google Maps.
    • GradeId; string; Value that uniquely identifies a person's grade.
    • JobId; string; Value that uniquely identifies a person's job.
    • LineDescrRequiredFlag; boolean; Indicates whether a line description is required to enter an expense.
    • OrganizationId; integer; Unique identifier of a person's organization.
    • PartyId; integer; Unique identifier of a party.
    • PersonId; integer; Unique identifier of the person associated with an expense profile attributes record.
    • PositionId; string; Value that uniquely identifies a person's position.
    • ProjectAccess; string; Access to project-related attributes by a user.
    • PurposeRequiredFlag; boolean; Indicates whether the user is required to enter a purpose when completing an expense report.
    • SubmitReportError; string; Error that displays during submission of an expense report.
    • TermsAgreementURL; string; URL for terms and agreement.
    • Userlocation; string; Work location of a user.
    • Version; string; Version of the server that is used for the mobile application to control features.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : expenseProfileAttributes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseProfileAttributes-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the expense profile attribute records of a person by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseProfileAttributes

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "PersonId": 100010026335772,
      "Userlocation": "San Jose, Santa Clara, CA, United States",
      "DefaultExpenseAccountId": 13798,
      "CompanySegment": null,
      "CostCenterSegment": null,
      "OrganizationId": 204,
      "BusinessUnitId": 204,
      "BUName": "Vision Operations",
      "ExpenseTemplateId": "10024",
      "ExpenseEntryFlag": true,
      "ExpenseAccess": "OK",
      "ProjectAccess": "Y",
      "AccountAccess": "Y",
      "CurrencyCode": "USD",
      "CurrencyName": "US Dollar",
      "Version": "2.3",
      "EnableReimbCurrencyFlag": true,
      "TermsAgreementURL": "www.oracle.com",
      "EnableProjectFieldsFlag": true,
      "PurposeRequiredFlag": false,
      "LineDescrRequiredFlag": false,
      "DisableCcMerchantNameFlag": null,
      "EnableAttachments": "B",
      "GoogleMapsAPIKey": null,
      "PartyId": 100010032637367,
      "DisableCompanySegment": "Y",
      "EnableSavePasswordFlag": true,
      "DisableScanFlag": null,
      "SubmitReportError": null,
      "JobId": "1409",
      "GradeId": null,
      "PositionId": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseProfileAttributes/100010026335772",
          "name": "expenseProfileAttributes",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseProfileAttributes/100010026335772",
          "name": "expenseProfileAttributes",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseProfileAttributes",
      "name": "expenseProfileAttributes",
      "kind": "collection"
    }
  ]
}
Back to Top