1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Expense Descriptive Flexfield Segments

Get a descriptive flexfield segment for expenses and expense reports

get

/fscmRestApi/resources/11.13.18.05/expenseDffSegments/{RowIdentifier}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : expenseDffSegments-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the Expenses application.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether the descriptive flexfield segment is available in Oracle Business Intelligence applications.
  • Read Only: true
    Maximum Length: 30
    Tag for descriptive flexfield segments enabled in Oracle Business Intelligence applications.
  • Read Only: true
    Maximum Length: 30
    Value of a descriptive flexfield segment field when the check box is selected.
  • Read Only: true
    Maximum Length: 30
    Value of a descriptive flexfield segment field when the check box is deselected.
  • Read Only: true
    Maximum Length: 30
    Name of the database column associated with the descriptive flexfield segment. The application stores the value captured for this descriptive flexfield segment in this column.
  • Read Only: true
    Maximum Length: 80
    Code that identifies the context of a descriptive flexfield segment, such as global context or context dependent on expense types.
  • Read Only: true
    Maximum Length: 64
    User who created the descriptive flexfield segment record.
  • Read Only: true
    Date when the descriptive flexfield segment record was created.
  • Read Only: true
    Maximum Length: 30
    Value that specifies how the default type is derived for the descriptive flexfield segment, such as SQL or a Groovy expression.
  • Read Only: true
    Maximum Length: 4000
    Default value for the descriptive flexfield segment when the data type is a string.
  • Read Only: true
    Default value for the descriptive flexfield segment when the data type is a string.
  • Read Only: true
    Default value for the descriptive flexfield segment when the data type is a number.
  • Read Only: true
    Default value for the descriptive flexfield segment when the data type is a time stamp.
  • Read Only: true
    Maximum Length: 80
    Field that derives the default value for the descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 240
    Detailed definition information about the descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 40
    Code that identifies a descriptive flexfield segment definition.
  • Read Only: true
    Height of a descriptive flexfield segment on a UI.
  • Read Only: true
    Maximum Length: 30
    Type of display that specifies how the application renders a descriptive flexfield segment on a UI.
  • Read Only: true
    Width of a descriptive flexfield segment on a UI.
  • Read Only: true
    Maximum Length: 1000
    Dynamic URL for the descriptive flexfield segment field.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether the descriptive flexfield segment is enabled. If disabled, the descriptive flexfield segment is not displayed.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether the descriptive flexfield segment is indexed.
  • Read Only: true
    Maximum Length: 160
    Help text that displays when the user hovers over a descriptive flexfield segment field.
  • Read Only: true
    Date when the descriptive flexfield segment record was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 32
    Session sign in of the user who last updated the descriptive flexfield segment record.
  • Links
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether a multirow descriptive flexfield segment has a unique key. An indicator that specifies if a multirow segment has a unique key.
  • Read Only: true
    Maximum Length: 60
    Name of the descriptive flexfield segment field as displayed on the application.
  • Read Only: true
    Maximum Length: 80
    Name of the descriptive flexfield segment field as displayed on the application.
  • Read Only: true
    Maximum Length: 30
    Type of range that specifies whether a value is set to the lower or higher end of the range.
  • Read Only: true
    Maximum Length: 1
    An indicator that specifies if the field can be modified.
  • Read Only: true
    Maximum Length: 1
    Option that indicates whether the descriptive flexfield segment is mandatory.
  • Read Only: true
    Value that uniquely identifies a descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 30
    Code that identifies the descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 30
    Value that uniquely identifies the descriptive flexfield segment.
  • Read Only: true
    Order in which descriptive flexfield segments are displayed on the Create Expense Item page and on the Create Expense Report page.
  • Read Only: true
    Maximum Length: 80
    Alternate prompt for the descriptive flexfield segment that is displayed on the UI.
  • Read Only: true
    Maximum Length: 1
    Description that displays when hovering over the descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 80
    Help text that displays when the user hovers over the label of a descriptive flexfield segment.
  • Read Only: true
    Maximum Length: 10
    Category of a unit of measurement in the metric system, that displays as a descriptive flexfield segment, such as meter that measures length, second that measures time, and kilogram that measures mass.
  • Read Only: true
    Value set that uniquely identifies the list of possible values and the data types for the descriptive flexfield segment.
Back to Top

Examples

The following example shows how to retrieve an expense descriptive flexfield segment by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffSegments/AAoDQ6AAJAAAHUtAAB

Example Response Body

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

{
  "RowIdentifier": "AAoDQ6AAJAAAHUtAAB",
  "ApplicationId": 10016,
  "DescriptiveFlexfieldCode": "EXM_EXPENSES",
  "ContextCode": "Meal",
  "SegmentCode": "Drink",
  "SegmentIdentifier": "drink",
  "ColumnName": "ATTRIBUTE_CHAR1",
  "SequenceNumber": 10,
  "EnabledFlag": true,
  "RequiredFlag": false,
  "ValueSetId": 111,
  "DefaultType": null,
  "DefaultValue": null,
  "DefaultValueNumber": null,
  "DefaultValueDate": null,
  "DefaultValueTimestamp": null,
  "DerivationValue": null,
  "RangeType": null,
  "ReadOnlyFlag": false,
  "DisplayType": "TEXT_BOX",
  "DisplayWidth": null,
  "DisplayHeight": null,
  "CheckboxCheckedValue": null,
  "CheckboxUncheckedValue": null,
  "DynamicURL": null,
  "UOMClass": null,
  "IndexedFlag": false,
  "MultirowUniqueKeyFlag": null,
  "BiEnabledFlag": false,
  "BiEqualizationTag": null,
  "ShowValueDescription": "N",
  "CreationDate": "2014-01-07T16:31:34.891+00:00",
  "CreatedBy": "APP_IMPL_CONSULTANT",
  "LastUpdateDate": "2014-01-07T16:33:34.360+00:00",
  "LastUpdatedBy": "APP_IMPL_CONSULTANT",
  "LastUpdateLogin": "EF6B765FCB23501AE0432620F00A6604",
  "Name": "Drink",
  "Description": null,
  "Prompt": "Drink",
  "ShortPrompt": "Drink",
  "TerminologyHelpText": null,
  "InFieldHelpText": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffSegments/AAoDQ6AAJAAAHUtAAB",
      "name": "expenseDffSegments",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffSegments/AAoDQ6AAJAAAHUtAAB",
      "name": "expenseDffSegments",
      "kind": "item"
    }
  ]
}
Back to Top