Get a descriptive flexfield context for expenses and expense reports
get
/fscmRestApi/resources/11.13.18.05/expenseDffContexts/{RowIdentifier}
Request
Path Parameters
-
RowIdentifier(required): string
Value that uniquely identifies a descriptive flexfield context.
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : expenseDffContexts-item-response
Type:
Show Source
object
-
ApplicationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the Expenses application. -
ContextCode: string
Read Only:
true
Maximum Length:80
Code that identifies the context, such as global context and context dependent on expense types. -
ContextIdentifier: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the descriptive flexfield context. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the descriptive flexfield context record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the descriptive flexfield context record was created. -
Description: string
Read Only:
true
Maximum Length:240
Description of the descriptive flexfield context field. -
DescriptiveFlexfieldCode: string
Read Only:
true
Maximum Length:40
Code that identifies the descriptive flexfield context definition. -
EnabledFlag: boolean
Read Only:
true
Maximum Length:1
Option that indicates whether the descriptive flexfield context is currently enabled. If disabled, the descriptive flexfield context is not displayed. -
InstructionHelpText: string
Read Only:
true
Maximum Length:400
Help text that displays when the user hovers over the descriptive flexfield context field. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the descriptive flexfield context record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the descriptive flexfield context record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session sign in of the user who last updated the descriptive flexfield context record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MultirowFlag: boolean
Read Only:
true
Maximum Length:1
Option that indicates whether the descriptive flexfield context field is displayed as multiple rows. -
Name: string
Read Only:
true
Maximum Length:80
Name of the descriptive flexfield context field. -
ProtectedFlag: boolean
Read Only:
true
Maximum Length:1
Option that indicates whether the descriptive flexfield context field is read-only. -
RowIdentifier: string
Read Only:
true
Value that uniquely identifies a descriptive flexfield context. -
TranslatableFlag: boolean
Read Only:
true
Maximum Length:1
Option that indicates whether the descriptive flexfield context field is available for translation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve an expense descriptive flexfield context 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/expenseDffContexts/AAoB3yADiAAFGJtAAv
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "RowIdentifier": "AAoB3yADiAAFGJtAAv", "ApplicationId": 10016, "DescriptiveFlexfieldCode": "EXM_EXPENSES", "ContextCode": "Laundry", "ContextIdentifier": "Laundry", "EnabledFlag": false, "ProtectedFlag": false, "MultirowFlag": null, "TranslatableFlag": null, "CreationDate": "2014-01-07T16:28:29.175+00:00", "CreatedBy": "APP_IMPL_CONSULTANT", "LastUpdateDate": "2014-01-07T16:29:28.994+00:00", "LastUpdatedBy": "APP_IMPL_CONSULTANT", "LastUpdateLogin": "EF6B765FCB23501AE0432620F00A6604", "Name": "Laundry", "Description": null, "InstructionHelpText": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffContexts/AAoB3yADiAAFGJtAAv", "name": "expenseDffContexts", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseDffContexts/AAoB3yADiAAFGJtAAv", "name": "expenseDffContexts", "kind": "item" } ] }