1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Shared Services
  4. Time Recording Entry Details

Get all time recording details

get

/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingDetailEntries

Request

Query Parameters
  • 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 time recording entry that matches the specified primary key criteria.
      Finder Variables:
      • TeEntryKey; integer; The unique identifier for the time recording entry.
    • simpleSearchFinder: Finds the time recording detail that matches the category, subcategory, or person name with the specified value criteria.
      Finder Variables:
      • value; string; The value for finding time recording details based on category, subcategory, or name.
  • 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:
    • AllowOverrideFlag; string; The allow override flag as defined for the time entry type.
    • AssessNowFlag; string; The assess now flag as defined for the time entry type.
    • BillRate; number; The hourly billing rate used for this time entry.
    • BillableFlag; string; Indicates whether or not the time recording entry is billable.
    • Category; string; The category as defined for the time entry type.
    • CategoryDescription; string; The category description as defined for the time entry type.
    • CategoryId; string; The unique identifier for category as defined for the time entry type.
    • Classification; string; The classification of the parent transaction associated with the time recording entry.
    • Comments; string; The comments entered for this time recording entry.
    • CurrencyCode; string; The currency code associated with the assessed fee for this time recording entry.
    • FeeAmount; number; The fee assessed for this time recording entry.
    • FeeRecordKey; integer; The unique identifier for the fee record associated with the time recording entry.
    • OverrideBillRate; number; The hourly billing rate used to override the default billing rate for this time entry.
    • ParentKey; integer; The unique identifier for the parent transaction, or classification-level transaction associated with the time recording entry. For example, Permit.
    • PaymentDate; string; The date when the last payment was made for any fees associated with the time recording entry.
    • PersonId; integer; The unique identifier for the agency staff associated with the time recording entry.
    • PersonName; string; The name of the agency staff associated with the time recording entry.
    • RecordedDate; string; The date when the entered time occurred.
    • RecordedHours; integer; The number of hours recorded for this time entry. This can be between 0 and 23 hours.
    • RecordedMinutes; integer; The number of minutes recorded for this time entry. This can be between 0 and 59 minutes.
    • Subcategory; string; The subcategory as defined for the time entry type.
    • SubcategoryDescription; string; The subcategory description as defined for the time entry type.
    • SubcategoryId; string; The unique identifier for subcategory as defined for the time entry type.
    • TeEntryKey; integer; The unique identifier for the time recording entry.
    • TimeRecordedUpdateDate; string; The date and time when the time recording entry was last updated.
    • TransactionKey; integer; The unique identifier for the child transaction associated with the time recording entry. For example, Inspection.
    • TransactionSource; string; A code representing the type of child transaction to which the time recording entry is associated. For example, INS for inspection.
    • TransactionTypeCode; string; The public unique identifier for the time entry type.
    • TransactionTypeKey; integer; The unique identifier for the time entry type associated with the time recording entry.
  • 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 : publicSectorTimeRecordingDetailEntries
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorTimeRecordingDetailEntries-item-response
Type: object
Show Source
Back to Top