Jump to

• Request
• Response

Create a migration process instance

post

/fscmRestApi/resources/11.13.18.05/publicSectorProcessMigrateActivities

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  Permitting and Licensing record classification, such as Permits or Business Licenses.
• MigActivityId: integer (int64)
  Unique identifier for the migration process instance.
• MigFromGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated from.
• MigrationStatus: string
  Maximum Length: 30

  Indicates if the process instance's migration was successful or not.
• MigToGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated to.
• PostMigCurTaskId: string
  Maximum Length: 500

  Workflow process instance???s current task???s task id after migration.
• PostMigProcessId: string
  Maximum Length: 100

  Workflow process ID after migration.
• PostMigProcessXrefKey: integer (int64)
  Process reference key after migration.
• PostMigWfConfig: string (byte)
  Workflow configuration associated with Peritting and Licensing record type after migration.
• PreMigCurTaskId: string
  Maximum Length: 500

  Workflow process instance???s current task???s task ID before migration.
• PreMigCurTaskStatus: string
  Maximum Length: 500

  Workflow process instance???s current task???s status before migration.
• PreMigProcessAudit: string (byte)
  Process audit information before migration.
• PreMigProcessDtl: string (byte)
  Process details before migration.
• PreMigProcessId: string
  Maximum Length: 100

  Workflow process ID before migration.
• PreMigProcessStatus: string
  Maximum Length: 100

  Workflow process instance status before migration.
• PreMigProcessXrefKey: integer (int64)
  Process reference key before migration.
• PreMigTaskDtl: string (byte)
  Task details before migration.
• PreMigWfConfig: string (byte)
  Worfklwo configuration associated with Permitting and Licensing record type before migration.
• RecordId: string
  Maximum Length: 100

  Record ID of a process instance.
• RecordKey: integer (int64)
  The transaction record key.
• RecordTypeId: string
  Maximum Length: 100

  The transactin record type ID.
• ResponseHttpCode: integer (int32)
  REST response code.
• RestResponse: string (byte)
  REST response returned by the Permitting and Licensing migration REST API.
• TransactionInfo: string (byte)
  This column contain transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, VERSION_TYPE.
• WfXrefPublishedFlag: string
  Maximum Length: 1

  Workflow process instance published flag.
• WorkflowType: string
  Maximum Length: 100

  The workflow type of a process instance, either PMT, PNZ or BL.

{
    "type":"object",
    "properties":{
        "PreMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process ID before migration.",
            "nullable":false
        },
        "RecordKey":{
            "type":"integer",
            "description":"The transaction record key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PreMigProcessDtl":{
            "type":"string",
            "description":"Process details before migration.",
            "format":"byte",
            "nullable":true
        },
        "WfXrefPublishedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Workflow process instance published flag.",
            "nullable":true
        },
        "PostMigCurTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s task id after migration.",
            "nullable":true
        },
        "MigrationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the process instance's migration was successful or not.",
            "nullable":true
        },
        "PreMigCurTaskStatus":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s status before migration.",
            "nullable":true
        },
        "PostMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process ID after migration.",
            "nullable":true
        },
        "PreMigTaskDtl":{
            "type":"string",
            "description":"Task details before migration.",
            "format":"byte",
            "nullable":true
        },
        "PreMigWfConfig":{
            "type":"string",
            "description":"Worfklwo configuration associated with Permitting and Licensing record type before migration.",
            "format":"byte",
            "nullable":true
        },
        "PostMigWfConfig":{
            "type":"string",
            "description":"Workflow configuration associated with Peritting and Licensing record type after migration.",
            "format":"byte",
            "nullable":true
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"Permitting and Licensing record classification, such as Permits or Business Licenses.",
            "nullable":true
        },
        "MigFromGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated from.",
            "nullable":true
        },
        "RecordTypeId":{
            "maxLength":100,
            "type":"string",
            "description":"The transactin record type ID.",
            "nullable":true
        },
        "TransactionInfo":{
            "type":"string",
            "description":"This column contain transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, VERSION_TYPE.",
            "format":"byte",
            "nullable":true
        },
        "PostMigProcessXrefKey":{
            "type":"integer",
            "description":"Process reference key after migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"Record ID of a process instance.",
            "nullable":false
        },
        "MigToGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated to.",
            "nullable":true
        },
        "PreMigProcessStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process instance status before migration.",
            "nullable":true
        },
        "MigActivityId":{
            "type":"integer",
            "description":"Unique identifier for the migration process instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PreMigProcessXrefKey":{
            "type":"integer",
            "description":"Process reference key before migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RestResponse":{
            "type":"string",
            "description":"REST response returned by the Permitting and Licensing migration REST API.",
            "format":"byte",
            "nullable":true
        },
        "PreMigCurTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s task ID before migration.",
            "nullable":true
        },
        "WorkflowType":{
            "maxLength":100,
            "type":"string",
            "description":"The workflow type of a process instance, either PMT, PNZ or BL.",
            "nullable":false
        },
        "ResponseHttpCode":{
            "type":"integer",
            "description":"REST response code.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "PreMigProcessAudit":{
            "type":"string",
            "description":"Process audit information before migration.",
            "format":"byte",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorProcessMigrateActivities-item-response

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  Permitting and Licensing record classification, such as Permits or Business Licenses.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MigActivityId: integer (int64)
  Unique identifier for the migration process instance.
• MigFromGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated from.
• MigrationStatus: string
  Maximum Length: 30

  Indicates if the process instance's migration was successful or not.
• MigToGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated to.
• PostMigCurTaskId: string
  Maximum Length: 500

  Workflow process instance???s current task???s task id after migration.
• PostMigProcessId: string
  Maximum Length: 100

  Workflow process ID after migration.
• PostMigProcessXrefKey: integer (int64)
  Process reference key after migration.
• PostMigWfConfig: string (byte)
  Workflow configuration associated with Peritting and Licensing record type after migration.
• PreMigCurTaskId: string
  Maximum Length: 500

  Workflow process instance???s current task???s task ID before migration.
• PreMigCurTaskStatus: string
  Maximum Length: 500

  Workflow process instance???s current task???s status before migration.
• PreMigProcessAudit: string (byte)
  Process audit information before migration.
• PreMigProcessDtl: string (byte)
  Process details before migration.
• PreMigProcessId: string
  Maximum Length: 100

  Workflow process ID before migration.
• PreMigProcessStatus: string
  Maximum Length: 100

  Workflow process instance status before migration.
• PreMigProcessXrefKey: integer (int64)
  Process reference key before migration.
• PreMigTaskDtl: string (byte)
  Task details before migration.
• PreMigWfConfig: string (byte)
  Worfklwo configuration associated with Permitting and Licensing record type before migration.
• RecordId: string
  Maximum Length: 100

  Record ID of a process instance.
• RecordKey: integer (int64)
  The transaction record key.
• RecordTypeId: string
  Maximum Length: 100

  The transactin record type ID.
• ResponseHttpCode: integer (int32)
  REST response code.
• RestResponse: string (byte)
  REST response returned by the Permitting and Licensing migration REST API.
• TransactionInfo: string (byte)
  This column contain transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, VERSION_TYPE.
• WfXrefPublishedFlag: string
  Maximum Length: 1

  Workflow process instance published flag.
• WorkflowType: string
  Maximum Length: 100

  The workflow type of a process instance, either PMT, PNZ or BL.

{
    "type":"object",
    "properties":{
        "PreMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process ID before migration.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The transaction record key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreMigProcessDtl":{
            "type":"string",
            "description":"Process details before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "WfXrefPublishedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Workflow process instance published flag.",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigCurTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s task id after migration.",
            "nullable":true,
            "x-queryable":true
        },
        "MigrationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the process instance's migration was successful or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigCurTaskStatus":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s status before migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process ID after migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigTaskDtl":{
            "type":"string",
            "description":"Task details before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigWfConfig":{
            "type":"string",
            "description":"Worfklwo configuration associated with Permitting and Licensing record type before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigWfConfig":{
            "type":"string",
            "description":"Workflow configuration associated with Peritting and Licensing record type after migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"Permitting and Licensing record classification, such as Permits or Business Licenses.",
            "nullable":true,
            "x-queryable":true
        },
        "MigFromGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated from.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":100,
            "type":"string",
            "description":"The transactin record type ID.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionInfo":{
            "type":"string",
            "description":"This column contain transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, VERSION_TYPE.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PostMigProcessXrefKey":{
            "type":"integer",
            "description":"Process reference key after migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"Record ID of a process instance.",
            "nullable":false,
            "x-queryable":true
        },
        "MigToGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigProcessStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow process instance status before migration.",
            "nullable":true,
            "x-queryable":true
        },
        "MigActivityId":{
            "type":"integer",
            "description":"Unique identifier for the migration process instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PreMigProcessXrefKey":{
            "type":"integer",
            "description":"Process reference key before migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RestResponse":{
            "type":"string",
            "description":"REST response returned by the Permitting and Licensing migration REST API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigCurTaskId":{
            "maxLength":500,
            "type":"string",
            "description":"Workflow process instance???s current task???s task ID before migration.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowType":{
            "maxLength":100,
            "type":"string",
            "description":"The workflow type of a process instance, either PMT, PNZ or BL.",
            "nullable":false,
            "x-queryable":true
        },
        "ResponseHttpCode":{
            "type":"integer",
            "description":"REST response code.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PreMigProcessAudit":{
            "type":"string",
            "description":"Process audit information before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top