Get all workflow activities
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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 workflow activity role by the primary key.
Finder Variables:- TransactionId; integer; Unique identifier for a transaction.
- PrimaryKey: Finds the workflow activity role by the primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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 unique identifier for the public sector agency.
- 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.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date and time of the row was created.
- CustomRestResource; string; The custom REST resource name.
- DueDate; string; The due date of the workflow task.
- EventDetail; string; The event detail for the workflow activity.
- LastUpdateDate; string; The date and time the row was last updated.
- LastUpdateLogin; string; The session login associated with the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the row.
- LnpRecStatus; string; The status of the record.
- ObjectVersionNumber; integer; The number used to implement optimistic locking. This number 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.
- OicPrcsDefId; string; The process definition ID used in the transaction.
- OicProcessId; integer; The process instance ID in Oracle Integration Cloud (OIC).
- OicTaskAction; string; The action which is taken for the task. It can be either a system or a custom action.
- OicTaskId; integer; The task ID for the human task in Oracle Integration Cloud (OIC) business process model.
- OicTaskName; string; The task name of the human task in Oracle Integration Cloud (OIC) business process model.
- OpaGenVersion; string; This indicates whether the process or task belongs to Oracle Integration Cloud (OIC) generation 3 for Oracle Policy Automation.
- OpaProcessId; string; The generation 3 process instance ID in Oracle Integration Cloud (OIC).
- OpaTaskId; string; The generation 3 task ID for a human task in a process definitions in Oracle Integration Cloud (OIC).
- Priority; integer; The priority of the workflow task.
- RecordId; string; The 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; integer; The 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.
- RequestHttpVerb; string; The HTTP method for REST request.
- ResourceName; string; The name of the REST end point.
- ResourceType; string; The resource type of the workflow activity.
- ResponseHttpCode; integer; The HTTP response code.
- RestProvider; string; The system to which the request is sent. The value can either be either PSCR (for Public Sector Compliance and Regulation) or OIC for Oracle Integration Cloud.
- SubClassName; string; The subclassification for the transaction type.
- TaskCreationDate; string; The date and time when the task was created in Oracle Integration Cloud (OIC) .
- TransactionId; integer; The unique identifier for the transaction.
- UpdatedByUser; string; The agency user who has updated the workflow task.
- UpdatedByUserId; string; The agency user ID who has updated the workflow task.
-
totalResults: boolean
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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".
-
REST-Framework-Version(required):
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.
Root Schema : publicSectorWorkflowActivities
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorWorkflowActivities-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier for the public sector agency.
-
Applicant: integer
(int64)
The unique identifier for the applicant.
-
AssignedBy: string
Maximum Length:
240
The agency user who has assigned the workflow task. -
AssignedById: string
Maximum Length:
100
The agency user ID who has assigned the workflow task. -
AssignedTo: string
Maximum Length:
240
The agency user to whom the task has been assigned. -
AssignedToId: string
Maximum Length:
100
The agency user ID for whom the task has been assigned. -
Classification: string
Maximum Length:
3
The record classification. The classifications can include permit, business license, professional license, or planning and zoning. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time of the row was created. -
CustomData: string
(byte)
The custom field to hold any other attribute specific to a particular workflow activity.
-
CustomRestResource: string
Maximum Length:
30
The custom REST resource name. -
DueDate: string
(date-time)
The due date of the workflow task.
-
EventDetail: string
Maximum Length:
400
The event detail for the workflow activity. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecStatus: string
Maximum Length:
100
The status of the record. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number 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.
-
OicPrcsDefId: string
Maximum Length:
100
The process definition ID used in the transaction. -
OicProcessId: integer
(int64)
The process instance ID in Oracle Integration Cloud (OIC).
-
OicTaskAction: string
Maximum Length:
400
The action which is taken for the task. It can be either a system or a custom action. -
OicTaskId: integer
(int64)
The task ID for the human task in Oracle Integration Cloud (OIC) business process model.
-
OicTaskName: string
Maximum Length:
400
The task name of the human task in Oracle Integration Cloud (OIC) business process model. -
OpaGenVersion: string
Maximum Length:
10
This indicates whether the process or task belongs to Oracle Integration Cloud (OIC) generation 3 for Oracle Policy Automation. -
OpaProcessId: string
Maximum Length:
100
The generation 3 process instance ID in Oracle Integration Cloud (OIC). -
OpaTaskId: string
Maximum Length:
100
The generation 3 task ID for a human task in a process definitions in Oracle Integration Cloud (OIC). -
Priority: integer
(int32)
The priority of the workflow task.
-
RecordId: string
Maximum Length:
50
The 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: integer
(int64)
The 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.
-
RequestHttpVerb: string
Maximum Length:
20
The HTTP method for REST request. -
RequestPayload: string
(byte)
The REST request payload.
-
RequestUrl: string
(byte)
The REST end point URL.
-
ResourceName: string
Maximum Length:
150
The name of the REST end point. -
ResourceType: string
Maximum Length:
150
The resource type of the workflow activity. -
ResponseHttpCode: integer
(int32)
The HTTP response code.
-
RestProvider: string
Maximum Length:
50
The system to which the request is sent. The value can either be either PSCR (for Public Sector Compliance and Regulation) or OIC for Oracle Integration Cloud. -
RestResponse: string
(byte)
The REST response payload.
-
SubClassName: string
Maximum Length:
50
The subclassification for the transaction type. -
TaskCreationDate: string
(date-time)
The date and time when the task was created in Oracle Integration Cloud (OIC) .
-
TransactionId: integer
(int64)
The unique identifier for the transaction.
-
UpdatedByUser: string
Maximum Length:
240
The agency user who has updated the workflow task. -
UpdatedByUserId: string
Maximum Length:
100
The agency user ID who has updated the workflow task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.