Get a single expense mileage policy line record for a given mileage policy rate line identifier
get
/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/{MileagePolicyId}/child/expenseMileagePolicyLines/{PolicyLineId}
Request
Path Parameters
-
MileagePolicyId(required): integer(int64)
Meals policy identifier.
-
PolicyLineId(required): integer(int64)
Mileage policy rate line identifier.
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 : expenseMileagePolicies-expenseMileagePolicyLines-item-response
Type:
Show Source
object
-
AdditionalRate: string
Read Only:
true
Additional rate code for which a rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
AdditionalRateCode: string
Maximum Length:
30
Code that is associated with an additional mileage rate. -
CalculationMethod: string
Title:
Meaning
Read Only:true
Maximum Length:80
Calculation method for deriving a passenger rate or an additional rate. Valid values are from the lookup EXM_CALCULATION_METHOD. -
CalculationMethodCode: string
Maximum Length:
30
Code that is associated with a calculation method. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the mileage policy rate line record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the mileage policy record rate line was created. -
Currency: string
Title:
Description
Read Only:true
Maximum Length:240
Description associated with a currency code. -
CurrencyCode: string
Maximum Length:
15
Code of the currency in which a mileage rate is defined. -
DistanceThreshold: number
Highest threshold value in the distance range for which this rate is applicable. For example, for a distance range of 0 - 4000 miles, the value 4000 is stored.
-
EndDate: string
(date)
Date from which the rate is no longer applicable.
-
FuelType: string
Read Only:
true
Type of fuel for which a mileage rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
FuelTypeCode: string
Maximum Length:
30
Code that is associated with a type of fuel. -
GeographyId: integer
(int64)
Geography for which this rate is applicable.
-
GeolocName: string
Maximum Length:
240
Geographical location for which this rate is applicable. -
InvalidCode: string
Maximum Length:
30
Code that is associated with an invalid attribute. -
InvalidDescription: string
Title:
Meaning
Read Only:true
Maximum Length:80
Reason a rate line failed validation. Valid values are from the lookup EXM_POLICY_INVALID_CODE. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the expense mileage policy rate line record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the mileage policy rate line record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login of the user who last updated the mileage policy rate line record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MileagePolicyId: integer
(int64)
Policy identifier for which rates are defined.
-
PassengerThreshold: integer
(int32)
Indicates number of passengers when rates by number range of passengers is selected.
-
PolicyLineId: integer
(int64)
Mileage policy rate line identifier.
-
Rate: number
Reimbursable amount for mileage, passenger, or additional rate that is determined by specific criteria.
-
RawCity: string
Maximum Length:
80
City of the location for which the rate is applicable. -
RawCountry: string
Maximum Length:
80
Country of the location for which the rate is applicable. -
RawCounty: string
Maximum Length:
80
County of the location for which the rate is applicable. -
RawState: string
Maximum Length:
80
State of the location for which the rate is applicable. -
RoleId: integer
(int64)
Role for which this rate is applicable.
-
RoleName: string
Maximum Length:
80
Role name for which this rate is applicable, such as Director or Engineer. -
StartDate: string
(date)
Date from which the rate is applicable.
-
Status: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of a rate line, such as Valid, Active, and Invalid. Valid values are from the lookup EXM_POLICY_STATUS. -
StatusCode: string
Maximum Length:
30
Code that is associated with the status of a rate line. -
VehicleCategory: string
Read Only:
true
Category of a vehicle for which a rate is applicable. Valid values are from the lookup defined in the mileage expense policy. -
VehicleCategoryCode: string
Maximum Length:
30
Code that is associated with a vehicle category. -
VehicleType: string
Read Only:
true
Type of vehicle for which a rate is applicable. Valid values are from the lookup defined in the expense policy. -
VehicleTypeCode: string
Maximum Length:
30
Code that is associated with a type of vehicle. -
Zone: string
Read Only:
true
Zone for which a rate is applicable, such as Geographical Location or Zone. -
ZoneCode: string
Maximum Length:
30
Code associated with a zone.
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 mileage policy line record 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/expenseMileagePolicies/300100031584792/child/expenseMileagePolicyLines/300100031584793
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AdditionalRateCode": null, "AdditionalRate": null, "CalculationMethodCode": null, "CalculationMethod": null, "CreatedBy": "EXPENSE_MANAGER", "CreationDate": "2013-12-19T16:09:48.176+00:00", "CurrencyCode": null, "Currency": null, "DistanceThreshold": null, "EndDate": null, "FuelTypeCode": null, "FuelType": null, "GeographyId": null, "GeolocName": null, "InvalidCode": null, "InvalidDescription": null, "LastUpdateDate": "2013-12-19T16:10:56.274+00:00", "LastUpdateLogin": "EDECAC6A2DB33DAAE0432620F00AE079", "LastUpdatedBy": "EXPENSE_MANAGER", "MileagePolicyId": 300100031584792, "PassengerThreshold": null, "PolicyLineId": 300100031584793, "Rate": 52, "RawCity": null, "RawCountry": null, "RawCounty": null, "RawState": null, "RoleId": null, "RoleName": null, "StartDate": "2013-12-19", "StatusCode": "ACTIVE", "Status": "Active", "VehicleCategoryCode": null, "VehicleCategory": null, "VehicleTypeCode": null, "VehicleType": null, "ZoneCode": null, "Zone": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792/child/expenseMileagePolicyLines/300100031584793", "name": "expenseMileagePolicyLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792/child/expenseMileagePolicyLines/300100031584793", "name": "expenseMileagePolicyLines", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/300100031584792", "name": "expenseMileagePolicies", "kind": "item" } ] }