Create a migration activity for an active application
post
/fscmRestApi/resources/11.13.18.05/publicSectorInflightMigrateActivities
Request
Header Parameters
-
Metadata-Context: string
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: string
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: string
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-
Classification: string
Maximum Length:
50The classification of permitting and licensing record, such as Permits or Business Licenses. -
CurrentWfAppVer: string
Maximum Length:
50The current workflow process version from which an active application is migrated. -
ErrorDetails: string
Maximum Length:
2000The error details occurred during the migration of an active application. -
InflightMigId: integer
(int64)
Unique identifier for the migration schedule associated with the migration activity.
-
MigActivityId: integer
(int64)
Unique identifier of the migration activity for an active application.
-
MigFromGenVersion: string
Maximum Length:
10The OCI Process Automation Generation migrated from. -
MigrationStatus: string
Maximum Length:
30Indicates whether the migration activity was successful or not. -
MigToGenVersion: string
Maximum Length:
10The OCI Process Automation Generation migrated to. -
PostMigCurTaskId: string
Maximum Length:
1000Task ID of the in-progress task belonging to the process instance associated with an active application after migration. -
PostMigProcessId: string
Maximum Length:
100Process ID of the process instance associated with an active application after the migration. -
PostMigProcessXrefKey: integer
(int64)
Process cross-reference key identifying the process instance associated with an active application after the migration.
-
PostMigWfConfig: string
(byte)
Workflow configuration associated with an active application after the migration.
-
PreMigCurTaskId: string
Maximum Length:
1000Task ID of the in-progress task belonging to the process instance associated with an active application before the migration. -
PreMigCurTaskStatus: string
Maximum Length:
1000Task status of the in-progress task belonging to the process instance associated with an active application before the migration. -
PreMigProcessAudit: string
(byte)
Process audit information for the process instance associated with an active application before the migration.
-
PreMigProcessDtl: string
(byte)
Process details for the process instance associated with an active application before the migration.
-
PreMigProcessId: string
Maximum Length:
100Process ID of the process instance associated with the active application before migration. -
PreMigProcessStatus: string
Maximum Length:
100Process status of the process instance associated with an active application before the migration. -
PreMigProcessXrefKey: integer
(int64)
Process cross-reference key identifying the process instance associated with an active application before the migration.
-
PreMigTaskDtl: string
(byte)
Task details for the in-progress task belonging to the process instance associated with an active application before the migration.
-
PreMigWfConfig: string
(byte)
Workflow configuration associated with an active application before the migration.
-
ProcessDefnName: string
Maximum Length:
100Workflow Process Definition Name associated with an active application. -
RecordId: string
Maximum Length:
100Transaction Record ID of an active application. -
RecordKey: integer
(int64)
Transaction Record Key of an active application.
-
RecordType: string
Maximum Length:
100Application Type to which an active application belongs to. -
RecordTypeId: string
Maximum Length:
100Application Type ID to which an active application belongs to. -
ResponseHttpCode: integer
(int32)
REST response code returned by the migration activity.
-
RestResponse: string
(byte)
REST response returned by the migration activity.
-
RetryCount: integer
(int32)
Number of retry attempts permitted to migrate an active application.
-
SubClassification: string
Maximum Length:
100Permitting and Licensing record sub-classification. -
TargetWfAppVer: string
Maximum Length:
50Target workflow process version to which an active application is migrated to. -
TransactionInfo: string
(byte)
This column contains transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, and VERSION_TYPE.
-
WfAppName: string
Maximum Length:
500The name of the workflow application. -
WfXrefPublishedFlag: string
Maximum Length:
1Indicates whether a migrated workflow configuration is published to the transaction record. -
WorkflowType: string
Maximum Length:
100The workflow type to which the process instance belongs to like structured or dynamic process.
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 : publicSectorInflightMigrateActivities-item-response
Type:
Show Source
object-
Classification: string
Maximum Length:
50The classification of permitting and licensing record, such as Permits or Business Licenses. -
CurrentWfAppVer: string
Maximum Length:
50The current workflow process version from which an active application is migrated. -
ErrorDetails: string
Maximum Length:
2000The error details occurred during the migration of an active application. -
InflightMigId: integer
(int64)
Unique identifier for the migration schedule associated with the migration activity.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MigActivityId: integer
(int64)
Unique identifier of the migration activity for an active application.
-
MigFromGenVersion: string
Maximum Length:
10The OCI Process Automation Generation migrated from. -
MigrationStatus: string
Maximum Length:
30Indicates whether the migration activity was successful or not. -
MigToGenVersion: string
Maximum Length:
10The OCI Process Automation Generation migrated to. -
PostMigCurTaskId: string
Maximum Length:
1000Task ID of the in-progress task belonging to the process instance associated with an active application after migration. -
PostMigProcessId: string
Maximum Length:
100Process ID of the process instance associated with an active application after the migration. -
PostMigProcessXrefKey: integer
(int64)
Process cross-reference key identifying the process instance associated with an active application after the migration.
-
PostMigWfConfig: string
(byte)
Workflow configuration associated with an active application after the migration.
-
PreMigCurTaskId: string
Maximum Length:
1000Task ID of the in-progress task belonging to the process instance associated with an active application before the migration. -
PreMigCurTaskStatus: string
Maximum Length:
1000Task status of the in-progress task belonging to the process instance associated with an active application before the migration. -
PreMigProcessAudit: string
(byte)
Process audit information for the process instance associated with an active application before the migration.
-
PreMigProcessDtl: string
(byte)
Process details for the process instance associated with an active application before the migration.
-
PreMigProcessId: string
Maximum Length:
100Process ID of the process instance associated with the active application before migration. -
PreMigProcessStatus: string
Maximum Length:
100Process status of the process instance associated with an active application before the migration. -
PreMigProcessXrefKey: integer
(int64)
Process cross-reference key identifying the process instance associated with an active application before the migration.
-
PreMigTaskDtl: string
(byte)
Task details for the in-progress task belonging to the process instance associated with an active application before the migration.
-
PreMigWfConfig: string
(byte)
Workflow configuration associated with an active application before the migration.
-
ProcessDefnName: string
Maximum Length:
100Workflow Process Definition Name associated with an active application. -
RecordId: string
Maximum Length:
100Transaction Record ID of an active application. -
RecordKey: integer
(int64)
Transaction Record Key of an active application.
-
RecordType: string
Maximum Length:
100Application Type to which an active application belongs to. -
RecordTypeId: string
Maximum Length:
100Application Type ID to which an active application belongs to. -
ResponseHttpCode: integer
(int32)
REST response code returned by the migration activity.
-
RestResponse: string
(byte)
REST response returned by the migration activity.
-
RetryCount: integer
(int32)
Number of retry attempts permitted to migrate an active application.
-
SubClassification: string
Maximum Length:
100Permitting and Licensing record sub-classification. -
TargetWfAppVer: string
Maximum Length:
50Target workflow process version to which an active application is migrated to. -
TransactionInfo: string
(byte)
This column contains transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, and VERSION_TYPE.
-
WfAppName: string
Maximum Length:
500The name of the workflow application. -
WfXrefPublishedFlag: string
Maximum Length:
1Indicates whether a migrated workflow configuration is published to the transaction record. -
WorkflowType: string
Maximum Length:
100The workflow type to which the process instance belongs to like structured or dynamic process.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.