1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Planning and Zoning
  4. Activity Logs

Get all activity logs

get

/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs

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 activities that match the specified search criteria.
      Finder Variables:
      • ActivityLogKey; integer; The unique identifier of the activity log.
    • simpleSearchFinder: Finds the activities that match the specified search criteria.
      Finder Variables:
      • value; string; The search value used to find the activities.
  • 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:
    • ActivityGroupId; string; The unique identifier for the activity group.
    • ActivityId; string; The unique identifier for the activity.
    • ActivityLogId; string; The unique identifier for the activity log ID.
    • ActivityLogKey; integer; The activity log key.
    • ActivityName; string; The activity name.
    • ActivityStatus; string; The status of the activity.
    • ActualCompletionDate; string; The date when the activity is completed.
    • AdhocFlag; string; This indicates whether the activity has been added by system trigger or by ad hoc activity.
    • AgencyId; integer; The unique identifier of the agency associated with the activity.
    • AssignedTo; string; The activity primary assignment.
    • BaseDate; string; The activity base date.
    • CreatedBy; string; The user who created the activity.
    • CreationDate; string; The date and time when the activity was created.
    • CurrentRowFlag; boolean; Indicates whether the row is the current row.
    • DueDateAdjust; string; This indicates whether the due date calculation should be adjusted to the prior or the next day based on if the due date falls on a weekend or holiday.
    • DuedateBasis; string; The base date field used to calculate the activity due date.
    • DuedateDuration; integer; The duration of the due date.
    • ExclDueDateCalc; string; This indicates how the due date calculation will be carried out whether to exclude weekends and holidays.
    • LastUpdateDate; string; The date and time when the activity was last updated.
    • LastUpdateLogin; string; The session login associated with the user who last updated the activity.
    • LastUpdatedBy; string; The user who last updated the activity.
    • LeadLagIndicator; string; Indicates whether the due date is before or after the basis date. Valid values are Days Before and Days After.
    • Meaning; string; The description of the base date.
    • ObjectVersionNumber; integer; The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
    • OccuranceCount; integer; The activity occurence count.
    • OriginalBaseDate; string; The activity original base date.
    • PlannedDueDate; string; The activity planned due date.
    • RecordId; string; The unique identifier of the record.
    • RecordKey; integer; The record key.
    • RedoFlag; string; Indicates whether an activity retrigger is required. The valid values are Y and N.
    • ResubmitFlag; string; Indicates whether the activity is allowed to be resubmitted. The valid values are Y and N.
    • ResubmittedFlag; boolean; Indicates whether the activity was resubmitted. The default value is false.
    • SystemStatus; string; The system status.
    • TranStatus; string; The transaction status associated with the activity.
    • TranType; string; The transaction type of the event trigger.
    • TransactionReferenceId; string; The transaction reference ID.
    • TransactionReferenceKey; integer; The transaction reference key.
    • UpdatedByUser; string; The user who last updated the activity.
  • 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 : publicSectorActivityLogs
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorActivityLogs-item-response
Type: object
Show Source
Back to Top