Get all offline tasks
get
/fscmRestApi/resources/11.13.18.05/publicSectorPcsOfflineTasks
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 a pending offline request that matches the primary key criteria specified.
Finder Variables:- TaskId; integer; The unique identifier for an offline task.
- simpleSearchFinder: Finds a pending offline request that matches the search criteria specified on the advanced filter tab.
Finder Variables:- intValue; integer; Finds a pending offline request that matches the search value.
- value; string; Finds a pending offline request that matches the search value.
- PrimaryKey: Finds a pending offline request that matches the primary key criteria specified.
-
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:- ApplicationId; string; The submitted transaction ID, such as a permit ID, which displays as a separate column on the page used to manage offline transactions.
- ApplicationType; string; The submitted transaction type, such as a permit type, which displays as a separate column on the page used to manage offline transactions.
- AttemptCount; integer; The number of attempts completed at trying to execute the HTTP request successfully.
- CoolingTime; integer; The time interval, specified in minutes, in which a failed HTTP request must be replayed.
- CreatedBy; string; The user who created the row.
- CreationDate; string; Indicates the date and time when the row was created.
- GlobalTaskActivityId; string; The global task activity ID.
- GlobalTaskId; string; The global task ID.
- LastUpdateDate; string; Indicates the date and time when the row was last updated.
- LastUpdateLogin; string; Indicates the session login associated to the user who last updated the row.
- LastUpdatedBy; string; Indicates the user who last updated the row.
- MaxAttempts; integer; The maximum number of attempts allowed for getting a positive response from OIC.
- ObjectVersionNumber; integer; The version number used to implement optimistic locking. This version number is incremented every time that the row is updated. The version number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
- OpaGenVersion; string; This indicates whether the process or task belongs to Oracle Integration Cloud (OIC) generation 3 for Oracle Policy Automation.
- ParentTaskId; integer; The task ID of the associated parent record if any.
- PrevTaskExecTime; string; The time at which the previous HTTP request was made.
- RequestHttpVerb; string; The request method or verb for the HTTP request.
- ResourceName; string; The name of the resource to which the request was made.
- ResponseHttpCode; integer; The status code received as response for the HTTP request.
- ServiceType; string; The type of service for the HTTP request.
- TaskExecStatus; integer; The task execution status of the current iteration.
- TaskId; integer; The task ID generated using Fusion Applications unique ID.
- TaskUserStatus; integer; The task status as specified by user.
- WfXrefKey; integer; The workflow cross reference key.
-
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 : publicSectorPcsOfflineTasks
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 : publicSectorPcsOfflineTasks-item-response
Type:
Show Source
object
-
ApplicationId: string
Maximum Length:
50
The submitted transaction ID, such as a permit ID, which displays as a separate column on the page used to manage offline transactions. -
ApplicationType: string
Maximum Length:
50
The submitted transaction type, such as a permit type, which displays as a separate column on the page used to manage offline transactions. -
AttemptCount: integer
(int32)
The number of attempts completed at trying to execute the HTTP request successfully.
-
CallbackMethodName: string
(byte)
The method that should be invoked upon success or failure of an offline request.
-
CoolingTime: integer
(int32)
The time interval, specified in minutes, in which a failed HTTP request must be replayed.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time when the row was created. -
GlobalTaskActivityId: string
Maximum Length:
500
The global task activity ID. -
GlobalTaskId: string
Maximum Length:
500
The global task ID. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxAttempts: integer
(int32)
The maximum number of attempts allowed for getting a positive response from OIC.
-
ObjectVersionNumber: integer
(int32)
The version number used to implement optimistic locking. This version number is incremented every time that the row is updated. The version number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OpaGenVersion: string
Maximum Length:
10
This indicates whether the process or task belongs to Oracle Integration Cloud (OIC) generation 3 for Oracle Policy Automation. -
ParentTaskId: integer
(int64)
The task ID of the associated parent record if any.
-
PrevTaskExecTime: string
(date-time)
The time at which the previous HTTP request was made.
-
RequestHeaders: string
(byte)
The request headers for the HTTP request.
-
RequestHttpVerb: string
Maximum Length:
20
The request method or verb for the HTTP request. -
RequestPayload: string
(byte)
The request payload for the HTTP request.
-
RequestUrl: string
(byte)
The URL to which the HTTP request was made.
-
ResourceName: string
Maximum Length:
150
The name of the resource to which the request was made. -
ResponseHttpCode: integer
(int32)
The status code received as response for the HTTP request.
-
RestResponse: string
(byte)
The response text received as response for the HTTP request.
-
ServiceType: string
Maximum Length:
50
The type of service for the HTTP request. -
TaskExecStatus: integer
(int32)
The task execution status of the current iteration.
-
TaskId: integer
(int64)
The task ID generated using Fusion Applications unique ID.
-
TaskUserStatus: integer
(int32)
The task status as specified by user.
-
WfXrefKey: integer
(int64)
The workflow cross reference key.
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.