Create a workflow activity
post
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowActivities
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root 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.