1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Shared Services
  4. Inconsistent Instances

Get all inconsistent instances

get

/fscmRestApi/resources/11.13.18.05/publicSectorOutOfSyncInstances

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 inconsistent instance that matches the specified primary key criteria.
      Finder Variables:
      • processId; string; The process instance ID in Oracle Integration Cloud (OIC).
      • recordId; string; A unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type, which can be a permit, a license, and so on.
      • recordKey; string; A unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type, which can be a permit, a license, and so on.
    • simpleSearchFinder: Finds the inconsistent instance that matches the specified search parameter.
      Finder Variables:
      • value; string; The search parameter that can be any of the attributes related to the inconsistent instance, such as its process ID, process state, and so on
  • 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:
    • activityUpdateDate; string; The date and time when the activity took place.
    • applicant; integer; The unique identifier for the applicant.
    • assignedBy; string; The agency user who has assigned the workflow task.
    • assignedById; string; The agency user ID who has assigned the workflow task.
    • assignedTo; string; The agency user to whom the task has been assigned.
    • assignedToId; string; The agency user ID for whom the task has been assigned.
    • classification; string; The record classification. The classifications can include permit, business license, professional license, or planning and zoning.
    • currentTask; string; The current task name of the human task in Oracle Integration Cloud (OIC) business process model.
    • hasProcess; string; The indicator that is used to identify whether the process is present.
    • hasRecord; string; The indicator that is used to identify whether the record is present.
    • lastActionTaken; string; The last action taken for the task. It can be either a system or a custom action.
    • masterService; string; Indicates which service is the master. It can have only two values: OIC or PSCR.
    • processCreatedDate; string; The date and time when the process was created.
    • processDefId; string; The process definition ID used in the transaction.
    • processId; string; The process instance ID in Oracle Integration Cloud (OIC).
    • processState; string; The state of the process in Oracle Integration Cloud (OIC).
    • processType; string; The process type of the record. It can have two values, STANDARD_PROCESS or DYNAMIC_PROCESS.
    • processUpdatedDate; string; The date and time when the process was updated.
    • recordCreatedDate; string; The date and time when the record was created.
    • recordId; string; A unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type, which can be a permit, a planning application, and so on.
    • recordKey; string; A unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
    • recordProcessId; string; The process ID present in the record detail.
    • recordStatus; string; The status of the record.
    • recordTypeId; string; The unique identifier for an application record type. This identifier is automatically generated based on the rules configured for the record type, which can be a permit, a planning application, and so on.
    • recordUpdatedDate; string; The date and time when the record was updated.
    • subClassification; string; The subclassification for the transaction type.
    • taskCreationDate; string; The date and time when the task was created in Oracle Integration Cloud (OIC) .
    • updatedByUser; string; The agency user who has updated the workflow task.
    • updatedByUserId; string; The agency user ID who has updated the workflow task.
  • 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 : publicSectorOutOfSyncInstances
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorOutOfSyncInstances-item-response
Type: object
Show Source
Back to Top