Jump to

• Request
• Response

Create a migration activity

post

/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowMigrateActivities

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  PSCR Record Classification.
• MigActivityId: integer (int64)
  The unique identifier for the migration activity.
• MigFromGenVersion: string
  Maximum Length: 10

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

  Indicates whether the workflow migration was successful or not.
• MigToGenVersion: string
  Maximum Length: 10

  OCI Process Automation Generation migrated to.
• PostMigWfConfig: string (byte)
  The workflow configuration associated with the PSCR record type after migration.
• PreMigWfConfig: string (byte)
  The workflow configuration associated with PSCR record type before migration.
• RecordTypeId: string
  Maximum Length: 100

  Identifies a unique PSCR Record Type Id that is associated with the workflow configuration.
• ResponseHttpCode: integer (int32)
  HTTP status code returned by the OCI Process Automation migration REST API.
• RestResponse: string (byte)
  REST response returned by the OCI Process Automation migration REST API.
• SubClassification: string
  Maximum Length: 100

  PSCR Record Sub Classification.
• WfAppKey: string
  Maximum Length: 1000

  The workflow process definition key.
• WfAppName: string
  Maximum Length: 500

  The workflow process definition name of decision model name.
• WfAppVersion: string
  Maximum Length: 50

  The workflow process definition version or decision model version.
• WfConfigPublishedFlag: string
  Maximum Length: 1

  Indicates whether the PSCR record was updated with the migrated workflow configuration or not.
• WorkflowType: string
  Maximum Length: 100

  The workflow type.

{
    "type":"object",
    "properties":{
        "WfAppVersion":{
            "maxLength":"50",
            "type":"string",
            "description":"The workflow process definition version or decision model version.",
            "nullable":false
        },
        "MigToGenVersion":{
            "maxLength":"10",
            "type":"string",
            "description":"OCI Process Automation Generation migrated to.",
            "nullable":true
        },
        "WfAppName":{
            "maxLength":"500",
            "type":"string",
            "description":"The workflow process definition name of decision model name.",
            "nullable":false
        },
        "MigActivityId":{
            "type":"integer",
            "description":"The unique identifier for the migration activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "WfConfigPublishedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the PSCR record was updated with the migrated workflow configuration or not.",
            "nullable":true
        },
        "RestResponse":{
            "type":"string",
            "description":"REST response returned by the OCI Process Automation migration REST API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WfAppKey":{
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition key.",
            "nullable":true
        },
        "SubClassification":{
            "maxLength":"100",
            "type":"string",
            "description":"PSCR Record Sub Classification.",
            "nullable":true
        },
        "MigrationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the workflow migration was successful or not.",
            "nullable":true
        },
        "PreMigWfConfig":{
            "type":"string",
            "description":"The workflow configuration associated with PSCR record type before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostMigWfConfig":{
            "type":"string",
            "description":"The workflow configuration associated with the PSCR record type after migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WorkflowType":{
            "maxLength":"100",
            "type":"string",
            "description":"The workflow type.",
            "nullable":false
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"PSCR Record Classification.",
            "nullable":true
        },
        "MigFromGenVersion":{
            "maxLength":"10",
            "type":"string",
            "description":"OCI Process Automation Generation migrated from.",
            "nullable":true
        },
        "RecordTypeId":{
            "maxLength":"100",
            "type":"string",
            "description":"Identifies a unique PSCR Record Type Id that is associated with the workflow configuration.",
            "nullable":false
        },
        "ResponseHttpCode":{
            "type":"integer",
            "description":"HTTP status code returned by the OCI Process Automation migration REST API.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        }
    }
}

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 : publicSectorWorkflowMigrateActivities-item-response

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  PSCR Record Classification.
• links: array Links
  Title: Links

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

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

  Indicates whether the workflow migration was successful or not.
• MigToGenVersion: string
  Maximum Length: 10

  OCI Process Automation Generation migrated to.
• PostMigWfConfig: string (byte)
  The workflow configuration associated with the PSCR record type after migration.
• PreMigWfConfig: string (byte)
  The workflow configuration associated with PSCR record type before migration.
• RecordTypeId: string
  Maximum Length: 100

  Identifies a unique PSCR Record Type Id that is associated with the workflow configuration.
• ResponseHttpCode: integer (int32)
  HTTP status code returned by the OCI Process Automation migration REST API.
• RestResponse: string (byte)
  REST response returned by the OCI Process Automation migration REST API.
• SubClassification: string
  Maximum Length: 100

  PSCR Record Sub Classification.
• WfAppKey: string
  Maximum Length: 1000

  The workflow process definition key.
• WfAppName: string
  Maximum Length: 500

  The workflow process definition name of decision model name.
• WfAppVersion: string
  Maximum Length: 50

  The workflow process definition version or decision model version.
• WfConfigPublishedFlag: string
  Maximum Length: 1

  Indicates whether the PSCR record was updated with the migrated workflow configuration or not.
• WorkflowType: string
  Maximum Length: 100

  The workflow type.

{
    "type":"object",
    "properties":{
        "WfAppVersion":{
            "maxLength":"50",
            "type":"string",
            "description":"The workflow process definition version or decision model version.",
            "nullable":false,
            "x-queryable":true
        },
        "MigToGenVersion":{
            "maxLength":"10",
            "type":"string",
            "description":"OCI Process Automation Generation migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "WfAppName":{
            "maxLength":"500",
            "type":"string",
            "description":"The workflow process definition name of decision model name.",
            "nullable":false,
            "x-queryable":true
        },
        "MigActivityId":{
            "type":"integer",
            "description":"The unique identifier for the migration activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WfConfigPublishedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the PSCR record was updated with the migrated workflow configuration or not.",
            "nullable":true,
            "x-queryable":true
        },
        "RestResponse":{
            "type":"string",
            "description":"REST response returned by the OCI Process Automation migration REST API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WfAppKey":{
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition key.",
            "nullable":true,
            "x-queryable":true
        },
        "SubClassification":{
            "maxLength":"100",
            "type":"string",
            "description":"PSCR Record Sub Classification.",
            "nullable":true,
            "x-queryable":true
        },
        "MigrationStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the workflow migration was successful or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigWfConfig":{
            "type":"string",
            "description":"The workflow configuration associated with PSCR record type before migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PostMigWfConfig":{
            "type":"string",
            "description":"The workflow configuration associated with the PSCR record type after migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WorkflowType":{
            "maxLength":"100",
            "type":"string",
            "description":"The workflow type.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"PSCR Record Classification.",
            "nullable":true,
            "x-queryable":true
        },
        "MigFromGenVersion":{
            "maxLength":"10",
            "type":"string",
            "description":"OCI Process Automation Generation migrated from.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"100",
            "type":"string",
            "description":"Identifies a unique PSCR Record Type Id that is associated with the workflow configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseHttpCode":{
            "type":"integer",
            "description":"HTTP status code returned by the OCI Process Automation migration REST API.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "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