Get a workflow activity
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities/{TransactionId}
Request
Path Parameters
-
TransactionId: integer
The unique identifier for the transaction.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorWorkflowActivities-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for the public sector agency.
-
Applicant(optional):
integer(int64)
The unique identifier for the applicant.
-
AssignedBy(optional):
string
Maximum Length:
240
The agency user who has assigned the workflow task. -
AssignedById(optional):
string
Maximum Length:
100
The agency user ID who has assigned the workflow task. -
AssignedTo(optional):
string
Maximum Length:
240
The agency user to whom the task has been assigned. -
AssignedToId(optional):
string
Maximum Length:
100
The agency user ID for whom the task has been assigned. -
Classification(optional):
string
Maximum Length:
3
The record classification. The classifications can include permit, business license, professional license, or planning and zoning. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the row. -
CreationDate(optional):
string(date-time)
The date and time of the row was created.
-
CustomRestResource(optional):
string
Maximum Length:
30
The custom REST resource name. -
LastUpdateDate(optional):
string(date-time)
The date and time the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the row. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecStatus(optional):
string
Maximum Length:
15
The status of the record. -
ObjectVersionNumber(optional):
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(optional):
string
Maximum Length:
100
The process definition ID used in the transaction. -
OicProcessId(optional):
number
The process instance ID in Oracle Integration Cloud (OIC).
-
OicTaskAction(optional):
string
Maximum Length:
400
The action which is taken for the task. It can be either a system or a custom action. -
OicTaskId(optional):
number
The task ID for the human task in Oracle Integration Cloud (OIC) business process model.
-
OicTaskName(optional):
string
Maximum Length:
400
The task name of the human task in Oracle Integration Cloud (OIC) business process model. -
RecordId(optional):
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(optional):
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(optional):
string
Maximum Length:
20
The HTTP method for REST request. -
RequestPayload(optional):
string
The REST request payload.
-
RequestUrl(optional):
string
The REST end point URL.
-
ResourceName(optional):
string
Maximum Length:
150
The name of the REST end point. -
ResponseHttpCode(optional):
integer(int32)
The HTTP response code.
-
RestProvider(optional):
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(optional):
string
The REST response payload.
-
SubClassName(optional):
string
Maximum Length:
50
The subclassification for the transaction type. -
TaskCreationDate(optional):
string(date-time)
The date and time when the task was created in Oracle Integration Cloud (OIC) .
-
TransactionId(optional):
integer(int64)
The unique identifier for the transaction.
-
UpdatedByUser(optional):
string
Maximum Length:
240
The agency user who has updated the workflow task. -
UpdatedByUserId(optional):
string
Maximum Length:
100
The agency user ID who has updated the workflow task.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.