Get an expense airfare policy
get
/fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies/{AirfarePolicyId}
Request
Path Parameters
-
AirfarePolicyId(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=
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 : expenseAirfarePolicies-item-response
Type:
Show Source
object
-
AirfarePolicyId: integer
(int64)
The unique identifier of the expense airfare policy record.
-
CreatedBy: string
Maximum Length:
64
User who created the row. -
CreationDate: string
(date-time)
Date and time when the row was created.
-
Description: string
Title:
Description
Maximum Length:240
Description of the airfare expense policy. -
DispWarningToUserFlag: boolean
Title:
Display Warning to User
Maximum Length:1
Indicates whether an airfare expense policy warning is displayed to the user. -
EnabledFlightDurationFlag: boolean
Title:
Flight Durations
Maximum Length:1
Indicates whether airline ticket class varies based on the flight duration. -
EnabledFlightTypeFlag: boolean
Title:
Flight Type
Maximum Length:1
Indicates whether airline ticket class varies based on the flight type. -
EnabledRoleFlag: boolean
Title:
Role
Maximum Length:1
Indicates whether airfare rates vary based on the role of an employee. -
expenseAirfarePolicyLines: array
Expense Airfare Policy Lines
Title:
Expense Airfare Policy Lines
The expense airfare policy lines resource is used to view airfare expense policy line records. -
FlightDurationCode: string
Title:
Duration
Maximum Length:30
Indicates the flight duration type, such as per leg or per whole trip. Value is provided by the expense manager. Values are from the lookup ORA_EXM_AIR_FLIGHT_DURATION. -
LastUpdateDate: string
(date-time)
Date and time when the row was last updated
-
LastUpdatedBy: string
Maximum Length:
64
User who last updated the row. -
LastUpdateLogin: string
Maximum Length:
32
Session login of user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number used to implement optimistic locking for an expense airfare policy. The number increments every time the row is updated. The value of the object version number at the start and end of a transaction are compared to detect whether another session has updated the row since it was queried.
-
PolicyEnforcement: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of airfare expense policy enforcement applied. -
PolicyEnforcementCode: string
Maximum Length:
30
Indicates the type of airfare expense policy enforcement applied. Values are from the lookup EXM_POLICY_ENFORCEMENT. -
PolicyName: string
Title:
Policy Name
Maximum Length:60
Name of the airfare expense policy. -
PolicyRole: string
Title:
Meaning
Read Only:true
Maximum Length:80
Role type that determines the airfare policy rate, such as Job, Grade, or Position. -
PolicyRoleCode: string
Title:
Role Type
Maximum Length:30
Indicates the role type that determines the policy rate. Values are from the lookup EXM_POLICY_ROLE. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Airfare policy status, such as Draft or Active. -
StatusCode: string
Title:
Status
Maximum Length:30
Indicates the airfare policy status. Values are from the lookup EXM_POLICY_STATUS.
Nested Schema : Expense Airfare Policy Lines
Type:
array
Title:
Expense Airfare Policy Lines
The expense airfare policy lines resource is used to view airfare expense policy line records.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseAirfarePolicies-expenseAirfarePolicyLines-item-response
Type:
Show Source
object
-
AirfarePolicyId: integer
(int64)
The unique identifier of the airfare policy for which rates are defined.
-
CreatedBy: string
Maximum Length:
64
User who created the row. -
CreationDate: string
(date-time)
Date and time when the row was created.
-
EndDate: string
(date)
Title:
End Date
Date at the end of the valid date range for airfare expense rate. -
FlightClassCode: string
Title:
Flight Class
Maximum Length:30
Airline ticket class such as economy class or business class. -
FlightClassCodeDomestic: string
Title:
Flight Class
Maximum Length:30
Airline ticket class such as economy class or business class, for domestic flights. -
FlightClassCodeInternat: string
Title:
Flight Class
Maximum Length:30
Airline ticket class such as economy class or business class, for international flights. -
FlightDurationThreshold: number
Title:
Duration
Expense manager can specify a flight duration threshold such that, above the threshold or below the threshold, a different flight class can be used. For example, airfare policy can be defined such that if flight duration is more than seven hours, employee can fly business class. -
Invalid: string
Title:
Meaning
Read Only:true
Maximum Length:80
The reason why the airfare expense policy rate line failed validation. -
InvalidCode: string
Maximum Length:
30
Code that indicates the reason why the airfare expense policy rate line failed validation. Values are from the lookup EXM_POLICY_INVALID_CODE. -
LastUpdateDate: string
(date-time)
Date and time when the row was last updated.
-
LastUpdatedBy: string
Maximum Length:
64
User who last updated the row. -
LastUpdateLogin: string
Maximum Length:
32
Session login of user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number used to implement optimistic locking for an expense airfare policy line. The number increments every time the row is updated. The value of the object version number at the start and end of a transaction are compared to detect whether another session has updated the row since it was queried.
-
PolicyLineId: integer
(int64)
The unique identifier of the airfare policy rate line.
-
RoleId: integer
(int64)
The unique identifier of the role for which the airfare policy rate is applicable.
-
RoleName: string
Title:
Role
Maximum Length:80
Role name for which the airfare policy rate is applicable, such as Director or Engineer. -
StartDate: string
(date)
Title:
Start Date
Date at the beginning of the valid date range for airfare expense rate. -
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the rate line, such as Valid, Active, or Invalid. -
StatusCode: string
Title:
Status
Maximum Length:30
Indicates the status of the rate line. Values are from the lookup EXM_POLICY_STATUS. -
TypeOfRateCode: string
Maximum Length:
30
Indicates if this line is a base airline line or a catch all line.
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.
Links
- expenseAirfarePolicyLines
-
Parameters:
- AirfarePolicyId:
$request.path.AirfarePolicyId
The expense airfare policy lines resource is used to view airfare expense policy line records. - AirfarePolicyId: