Jump to

• Request
• Response
• Examples

Get all descriptive flexfield segments for expenses and expense reports

get

/fscmRestApi/resources/11.13.18.05/expenseDffSegments

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 descriptive flexfield segment using an identifier that matches the primary key criteria specified.
    Finder Variables:
    • RowIdentifier; string; Row identifier of the expense and expense report descriptive flexfield segment record.
• 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:
  

  • ApplicationId; integer; Value that uniquely identifies the Expenses application.
  • BiEnabledFlag; boolean; Option that indicates whether the descriptive flexfield segment is available in Oracle Business Intelligence applications.
  • BiEqualizationTag; string; Tag for descriptive flexfield segments enabled in Oracle Business Intelligence applications.
  • CheckboxCheckedValue; string; Value of a descriptive flexfield segment field when the check box is selected.
  • CheckboxUncheckedValue; string; Value of a descriptive flexfield segment field when the check box is deselected.
  • ColumnName; string; 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.
  • ContextCode; string; Code that identifies the context of a descriptive flexfield segment, such as global context or context dependent on expense types.
  • CreatedBy; string; User who created the descriptive flexfield segment record.
  • CreationDate; string; Date when the descriptive flexfield segment record was created.
  • DefaultType; string; Value that specifies how the default type is derived for the descriptive flexfield segment, such as SQL or a Groovy expression.
  • DefaultValue; string; Default value for the descriptive flexfield segment when the data type is a string.
  • DefaultValueDate; string; Default value for the descriptive flexfield segment when the data type is a string.
  • DefaultValueNumber; number; Default value for the descriptive flexfield segment when the data type is a number.
  • DefaultValueTimestamp; string; Default value for the descriptive flexfield segment when the data type is a time stamp.
  • DerivationValue; string; Field that derives the default value for the descriptive flexfield segment.
  • Description; string; Detailed definition information about the descriptive flexfield segment.
  • DescriptiveFlexfieldCode; string; Code that identifies a descriptive flexfield segment definition.
  • DisplayHeight; integer; Height of a descriptive flexfield segment on a UI.
  • DisplayType; string; Type of display that specifies how the application renders a descriptive flexfield segment on a UI.
  • DisplayWidth; integer; Width of a descriptive flexfield segment on a UI.
  • DynamicURL; string; Dynamic URL for the descriptive flexfield segment field.
  • EnabledFlag; boolean; Option that indicates whether the descriptive flexfield segment is enabled. If disabled, the descriptive flexfield segment is not displayed.
  • InFieldHelpText; string; Help text that displays when the user hovers over a descriptive flexfield segment field.
  • IndexedFlag; boolean; Option that indicates whether the descriptive flexfield segment is indexed.
  • LastUpdateDate; string; Date when the descriptive flexfield segment record was last updated.
  • LastUpdateLogin; string; Session sign in of the user who last updated the descriptive flexfield segment record.
  • LastUpdatedBy; string; User who last updated the descriptive flexfield segment.
  • MultirowUniqueKeyFlag; boolean; 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.
  • Name; string; Name of the descriptive flexfield segment field as displayed on the application.
  • Prompt; string; Name of the descriptive flexfield segment field as displayed on the application.
  • RangeType; string; Type of range that specifies whether a value is set to the lower or higher end of the range.
  • ReadOnlyFlag; boolean; An indicator that specifies if the field can be modified.
  • RequiredFlag; boolean; Option that indicates whether the descriptive flexfield segment is mandatory.
  • RowIdentifier; string; Value that uniquely identifies a descriptive flexfield segment.
  • SegmentCode; string; Code that identifies the descriptive flexfield segment.
  • SegmentIdentifier; string; Value that uniquely identifies the descriptive flexfield segment.
  • SequenceNumber; integer; Order in which descriptive flexfield segments are displayed on the Create Expense Item page and on the Create Expense Report page.
  • ShortPrompt; string; Alternate prompt for the descriptive flexfield segment that is displayed on the UI.
  • ShowValueDescription; string; Description that displays when hovering over the descriptive flexfield segment.
  • TerminologyHelpText; string; Help text that displays when the user hovers over the label of a descriptive flexfield segment.
  • UOMClass; string; 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.
  • ValueSetId; integer; Value set that uniquely identifies the list of possible values and the data types for the descriptive flexfield segment.
• 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 : expenseDffSegments

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/expenseDffSegments-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object expenseDffSegments-item-response

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

Type: object

Show Source

• ApplicationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the Expenses application.
• BiEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Option that indicates whether the descriptive flexfield segment is available in Oracle Business Intelligence applications.
• BiEqualizationTag: string
  Read Only: true

  Maximum Length: 30

  Tag for descriptive flexfield segments enabled in Oracle Business Intelligence applications.
• CheckboxCheckedValue: string
  Read Only: true

  Maximum Length: 30

  Value of a descriptive flexfield segment field when the check box is selected.
• CheckboxUncheckedValue: string
  Read Only: true

  Maximum Length: 30

  Value of a descriptive flexfield segment field when the check box is deselected.
• ColumnName: string
  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.
• ContextCode: string
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the descriptive flexfield segment record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the descriptive flexfield segment record was created.
• DefaultType: string
  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.
• DefaultValue: string
  Read Only: true

  Maximum Length: 4000

  Default value for the descriptive flexfield segment when the data type is a string.
• DefaultValueDate: string (date)
  Read Only: true

  Default value for the descriptive flexfield segment when the data type is a string.
• DefaultValueNumber: number
  Read Only: true

  Default value for the descriptive flexfield segment when the data type is a number.
• DefaultValueTimestamp: string (date-time)
  Read Only: true

  Default value for the descriptive flexfield segment when the data type is a time stamp.
• DerivationValue: string
  Read Only: true

  Maximum Length: 80

  Field that derives the default value for the descriptive flexfield segment.
• Description: string
  Read Only: true

  Maximum Length: 240

  Detailed definition information about the descriptive flexfield segment.
• DescriptiveFlexfieldCode: string
  Read Only: true

  Maximum Length: 40

  Code that identifies a descriptive flexfield segment definition.
• DisplayHeight: integer (int32)
  Read Only: true

  Height of a descriptive flexfield segment on a UI.
• DisplayType: string
  Read Only: true

  Maximum Length: 30

  Type of display that specifies how the application renders a descriptive flexfield segment on a UI.
• DisplayWidth: integer (int32)
  Read Only: true

  Width of a descriptive flexfield segment on a UI.
• DynamicURL: string
  Read Only: true

  Maximum Length: 1000

  Dynamic URL for the descriptive flexfield segment field.
• EnabledFlag: boolean
  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.
• IndexedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Option that indicates whether the descriptive flexfield segment is indexed.
• InFieldHelpText: string
  Read Only: true

  Maximum Length: 160

  Help text that displays when the user hovers over a descriptive flexfield segment field.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the descriptive flexfield segment record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the descriptive flexfield segment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session sign in of the user who last updated the descriptive flexfield segment record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultirowUniqueKeyFlag: boolean
  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.
• Name: string
  Read Only: true

  Maximum Length: 60

  Name of the descriptive flexfield segment field as displayed on the application.
• Prompt: string
  Read Only: true

  Maximum Length: 80

  Name of the descriptive flexfield segment field as displayed on the application.
• RangeType: string
  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.
• ReadOnlyFlag: boolean
  Read Only: true

  Maximum Length: 1

  An indicator that specifies if the field can be modified.
• RequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Option that indicates whether the descriptive flexfield segment is mandatory.
• RowIdentifier: string
  Read Only: true

  Value that uniquely identifies a descriptive flexfield segment.
• SegmentCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the descriptive flexfield segment.
• SegmentIdentifier: string
  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the descriptive flexfield segment.
• SequenceNumber: integer (int32)
  Read Only: true

  Order in which descriptive flexfield segments are displayed on the Create Expense Item page and on the Create Expense Report page.
• ShortPrompt: string
  Read Only: true

  Maximum Length: 80

  Alternate prompt for the descriptive flexfield segment that is displayed on the UI.
• ShowValueDescription: string
  Read Only: true

  Maximum Length: 1

  Description that displays when hovering over the descriptive flexfield segment.
• TerminologyHelpText: string
  Read Only: true

  Maximum Length: 80

  Help text that displays when the user hovers over the label of a descriptive flexfield segment.
• UOMClass: string
  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.
• ValueSetId: integer (int64)
  Read Only: true

  Value set that uniquely identifies the list of possible values and the data types for the descriptive flexfield segment.

{
    "type":"object",
    "properties":{
        "DisplayHeight":{
            "type":"integer",
            "description":"Height of a descriptive flexfield segment on a UI.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the descriptive flexfield segment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Detailed definition information about the descriptive flexfield segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentIdentifier":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the descriptive flexfield segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the descriptive flexfield segment field as displayed on the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BiEqualizationTag":{
            "maxLength":30,
            "type":"string",
            "description":"Tag for descriptive flexfield segments enabled in Oracle Business Intelligence applications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":4000,
            "type":"string",
            "description":"Default value for the descriptive flexfield segment when the data type is a string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RangeType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of range that specifies whether a value is set to the lower or higher end of the range.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueDate":{
            "type":"string",
            "description":"Default value for the descriptive flexfield segment when the data type is a string.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueNumber":{
            "type":"number",
            "description":"Default value for the descriptive flexfield segment when the data type is a number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivationValue":{
            "maxLength":80,
            "type":"string",
            "description":"Field that derives the default value for the descriptive flexfield segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptiveFlexfieldCode":{
            "maxLength":40,
            "type":"string",
            "description":"Code that identifies a descriptive flexfield segment definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Order in which descriptive flexfield segments are displayed on the Create Expense Item page and on the Create Expense Report page.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "DisplayWidth":{
            "type":"integer",
            "description":"Width of a descriptive flexfield segment on a UI.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TerminologyHelpText":{
            "maxLength":80,
            "type":"string",
            "description":"Help text that displays when the user hovers over the label of a descriptive flexfield segment.",
            "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"
            }
        },
        "ContextCode":{
            "maxLength":80,
            "type":"string",
            "description":"Code that identifies the context of a descriptive flexfield segment, such as global context or context dependent on expense types.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the descriptive flexfield segment is enabled. If disabled, the descriptive flexfield segment is not displayed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMClass":{
            "maxLength":10,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckboxUncheckedValue":{
            "maxLength":30,
            "type":"string",
            "description":"Value of a descriptive flexfield segment field when the check box is deselected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Dynamic URL for the descriptive flexfield segment field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShortPrompt":{
            "maxLength":80,
            "type":"string",
            "description":"Alternate prompt for the descriptive flexfield segment that is displayed on the UI.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"Value set that uniquely identifies the list of possible values and the data types for the descriptive flexfield segment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the descriptive flexfield segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IndexedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the descriptive flexfield segment is indexed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the descriptive flexfield segment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of display that specifies how the application renders a descriptive flexfield segment on a UI.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InFieldHelpText":{
            "maxLength":160,
            "type":"string",
            "description":"Help text that displays when the user hovers over a descriptive flexfield segment field.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies how the default type is derived for the descriptive flexfield segment, such as SQL or a Groovy expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RowIdentifier":{
            "type":"string",
            "description":"Value that uniquely identifies a descriptive flexfield segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MultirowUniqueKeyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnName":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BiEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the descriptive flexfield segment is available in Oracle Business Intelligence applications.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the descriptive flexfield segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueTimestamp":{
            "type":"string",
            "description":"Default value for the descriptive flexfield segment when the data type is a time stamp.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the descriptive flexfield segment is mandatory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Prompt":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the descriptive flexfield segment field as displayed on the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckboxCheckedValue":{
            "maxLength":30,
            "type":"string",
            "description":"Value of a descriptive flexfield segment field when the check box is selected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowValueDescription":{
            "maxLength":1,
            "type":"string",
            "description":"Description that displays when hovering over the descriptive flexfield segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Expenses application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReadOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"An indicator that specifies if the field can be modified.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the descriptive flexfield segment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session sign in of the user who last updated the descriptive flexfield segment record.",
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all the expense descriptive flexfield segments 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/expenseDffSegments

Example Response Body

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

{
  "items": [
    {
      "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"
        }
      ]
    },
	...
  ],
  "count": 10,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffSegments",
      "name": "expenseDffSegments",
      "kind": "collection"
    }
  ]
}

Back to Top