Get all expense airfare policy lines

get

/fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies/{AirfarePolicyId}/child/expenseAirfarePolicyLines

Request

Path Parameters
  • 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
  • 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
  • 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 expense airfare policy line record that matches the primary key criteria specified.
      Finder Variables
      • PolicyLineId; integer; The unique identifier of the expense airfare policy line record.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AirfarePolicyId; integer; The unique identifier of the airfare policy for which rates are defined.
    • CreatedBy; string; User who created the row.
    • CreationDate; string; Date and time when the row was created.
    • EndDate; string; Date at the end of the valid date range for airfare expense rate.
    • FlightClassCode; string; Airline ticket class such as economy class or business class.
    • FlightClassCodeDomestic; string; Airline ticket class such as economy class or business class, for domestic flights.
    • FlightClassCodeInternat; string; Airline ticket class such as economy class or business class, for international flights.
    • FlightDurationThreshold; number; 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; The reason why the airfare expense policy rate line failed validation.
    • InvalidCode; string; 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 and time when the row was last updated.
    • LastUpdateLogin; string; Session login of user who last updated the row.
    • LastUpdatedBy; string; User who last updated the row.
    • ObjectVersionNumber; integer; 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; The unique identifier of the airfare policy rate line.
    • RoleId; integer; The unique identifier of the role for which the airfare policy rate is applicable.
    • RoleName; string; Role name for which the airfare policy rate is applicable, such as Director or Engineer.
    • StartDate; string; Date at the beginning of the valid date range for airfare expense rate.
    • Status; string; Status of the rate line, such as Valid, Active, or Invalid.
    • StatusCode; string; Indicates the status of the rate line. Values are from the lookup EXM_POLICY_STATUS.
    • TypeOfRateCode; string; Indicates if this line is a base airline line or a catch all line.
  • 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
  • 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 : expenseAirfarePolicies-expenseAirfarePolicyLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseAirfarePolicies-expenseAirfarePolicyLines-item-response
Type: object
Show Source
  • The unique identifier of the airfare policy for which rates are defined.
  • Maximum Length: 64
    User who created the row.
  • Date and time when the row was created.
  • Title: End Date
    Date at the end of the valid date range for airfare expense rate.
  • Title: Flight Class
    Maximum Length: 30
    Airline ticket class such as economy class or business class.
  • Title: Flight Class
    Maximum Length: 30
    Airline ticket class such as economy class or business class, for domestic flights.
  • Title: Flight Class
    Maximum Length: 30
    Airline ticket class such as economy class or business class, for international flights.
  • 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.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    The reason why the airfare expense policy rate line failed validation.
  • 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.
  • Date and time when the row was last updated.
  • Maximum Length: 64
    User who last updated the row.
  • Maximum Length: 32
    Session login of user who last updated the row.
  • Links
  • 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.
  • The unique identifier of the airfare policy rate line.
  • The unique identifier of the role for which the airfare policy rate is applicable.
  • Title: Role
    Maximum Length: 80
    Role name for which the airfare policy rate is applicable, such as Director or Engineer.
  • Title: Start Date
    Date at the beginning of the valid date range for airfare expense rate.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the rate line, such as Valid, Active, or Invalid.
  • Title: Status
    Maximum Length: 30
    Indicates the status of the rate line. Values are from the lookup EXM_POLICY_STATUS.
  • Maximum Length: 30
    Indicates if this line is a base airline line or a catch all line.
Back to Top