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

Get all assigned tasks

get

/fscmRestApi/resources/11.13.18.05/publicSectorTasks

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 a task that matches the specified primary key criteria.
      Finder Variables:
      • taskId; string; The unique identifier for a task.
    • simpleSearchFinder: Finds the task that matches the specified search parameter.
      Finder Variables:
      • value; string; The search parameter that can be any of the attributes related to the task, such as its name, type, assignee, 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:
    • activeStatus; string; Indicates whether the task is ongoing or active.
    • addressCityStatePostalCode; string; City, state and postal code of the contact person listed in the transaction type.
    • addressLine1; string; This field contains the values for both address 1 and address 2 of the contact person.
    • addressLine2; string; This field contains the value for address 3 of the contact person.
    • assignedBy; string; The agency staff member who has assigned the task.
    • assignedDate; string; The date on which the task was assigned.
    • assignedTo; string; Indicates whether the task is assigned to a user or a group of users.
    • assignee; string; The assignee of the task. The assignee could be an agency user or a group of users.
    • assignmentType; string; Indicates whether the task is assigned to a user or a group of users.
    • contactName; string; The name of the person to be contacted regarding the task.
    • contactPreference; string; Indicates the preferred method of contact, such as email, phone, or text.
    • customFields; string; This field is used to hold any other attribute specific to a particular task type.
    • description; string; The description of the individual transaction type, such as the permit, business license, and so on.
    • dueDate; string; The date for which a task is scheduled or on which it is due.
    • email; string; The email address of the contact person.
    • lastUpdatedDate; string; The date on which the task was last updated.
    • newIndicator; string; The indicator that is used to identify a new task.
    • permitStatus; string; The transaction type status.
    • phone; string; The phone number of the contact person.
    • primaryAddress; string; The primary address of the contact person.
    • priority; string; The priority of the task.
    • processInstanceId; string; The unique identifier of the business process instance related to this task.
    • recordId; string; The unique identifier of the application record.
    • recordKey; string; The unique identifier of the record associated with the application record.
    • recordType; string; The type of application record.
    • recordTypeDesc; string; The description of the transaction type.
    • status; string; The progress status of the task.
    • systemActions; string; The list of available actions that can be performed on the task.
    • systemStatus; string; The system code that represents the status of the task.
    • taskId; string; The unique identifier of a task.
    • taskName; string; The name given to the task.
    • taskType; string; The type of 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 : publicSectorTasks
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorTasks-item-response
Type: object
Show Source
Back to Top