1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Code Enforcement
  4. Incident Status Histories

Get all incident status history records

get

/fscmRestApi/resources/11.13.18.05/publicSectorIncStatusHistories

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 an incident status history event using the specified key.
      Finder Variables:
      • AgencyId; integer; The unique identifier for an agency.
      • Classification; string; The classification for a group of status codes. For incident status history, the value is always Incident.
      • Status; string; A code enforcement status code.
      • StatusHistKey; integer; The unique identifier of the incident status history record.
    • StatusHistPUIDAltKey: Finds an incident status history event using the specified key.
      Finder Variables:
      • StatusHistPuid; string; The public unique identifier for a migrated incident status history 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:
    • AgencyId; integer; The identifier for the agency that is associated with group of status codes.
    • AttributeChanged; string; The attribute that changed. This attribute is always the incident status.
    • ChangeDate; string; Date of the status change.
    • Classification; string; The classification for a group of status codes. For incident status history, the value is always Incident.
    • CreatedByName; string; The name of the user who created the row.
    • CreationDate; string; The date and time when the row was created.
    • IncidentPuid; string; The public unique identifier for a migrated parent incident record.
    • LastUpdateDate; string; The date and time when the row was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the row.
    • Meaning; string; The description of the close reason for closed incidents.
    • Reason; string; The reason for modifying the status.
    • RelAttributeChanged; string; The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the incident transaction, the main attribute is the user-facing incident status, and the secondary attribute is an internally-maintained status for the incident.
    • RelNewValue; string; The value of the status after the modification.
    • Status; string; The status code for the new status.
    • StatusHistKey; integer; The unique identifier of the incident status history record.
    • StatusHistPuid; string; The public unique identifier for a migrated record.
    • StatusName; string; The description of a status code.
    • TransactionId; string; The unique identifier of the incident.
    • TransactionKey; integer; The key of the source incident.
    • TransactionType; string; The type of transaction whose history is being tracked. For incident status history, the value is always Incident.
  • 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 : publicSectorIncStatusHistories
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorIncStatusHistories-item-response
Type: object
Show Source
Back to Top