Jump to

• Request
• Response

Get information about migration activity for an active application

get

/fscmRestApi/resources/11.13.18.05/publicSectorInflightMigrateActivities/{MigActivityId}

Request

Path Parameters

• MigActivityId(required): integer(int64)
  Unique identifier of the migration activity for an active application.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• Classification: string
  Maximum Length: 50

  The classification of permitting and licensing record, such as Permits or Business Licenses.
• CurrentWfAppVer: string
  Maximum Length: 50

  The current workflow process version from which an active application is migrated.
• ErrorDetails: string
  Maximum Length: 2000

  The 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: Links

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

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

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

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

  Task ID of the in-progress task belonging to the process instance associated with an active application after migration.
• PostMigProcessId: string
  Maximum Length: 100

  Process 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: 1000

  Task ID of the in-progress task belonging to the process instance associated with an active application before the migration.
• PreMigCurTaskStatus: string
  Maximum Length: 1000

  Task 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: 100

  Process ID of the process instance associated with the active application before migration.
• PreMigProcessStatus: string
  Maximum Length: 100

  Process 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: 100

  Workflow Process Definition Name associated with an active application.
• RecordId: string
  Maximum Length: 100

  Transaction Record ID of an active application.
• RecordKey: integer (int64)
  Transaction Record Key of an active application.
• RecordType: string
  Maximum Length: 100

  Application Type to which an active application belongs to.
• RecordTypeId: string
  Maximum Length: 100

  Application 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: 100

  Permitting and Licensing record sub-classification.
• TargetWfAppVer: string
  Maximum Length: 50

  Target 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: 500

  The name of the workflow application.
• WfXrefPublishedFlag: string
  Maximum Length: 1

  Indicates whether a migrated workflow configuration is published to the transaction record.
• WorkflowType: string
  Maximum Length: 100

  The workflow type to which the process instance belongs to like structured or dynamic process.

{
    "type":"object",
    "properties":{
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The classification of permitting and licensing record, such as Permits or Business Licenses.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentWfAppVer":{
            "maxLength":50,
            "type":"string",
            "description":"The current workflow process version from which an active application is migrated.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorDetails":{
            "maxLength":2000,
            "type":"string",
            "description":"The error details occurred during the migration of an active application.",
            "nullable":true,
            "x-queryable":true
        },
        "InflightMigId":{
            "type":"integer",
            "description":"Unique identifier for the migration schedule associated with the migration activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MigActivityId":{
            "type":"integer",
            "description":"Unique identifier of the migration activity for an active application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MigFromGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated from.",
            "nullable":true,
            "x-queryable":true
        },
        "MigToGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "MigrationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the migration activity was successful or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigCurTaskId":{
            "maxLength":1000,
            "type":"string",
            "description":"Task ID of the in-progress task belonging to the process instance associated with an active application after migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Process ID of the process instance associated with an active application after the migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PostMigProcessXrefKey":{
            "type":"integer",
            "description":"Process cross-reference key identifying the process instance associated with an active application after the migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostMigWfConfig":{
            "type":"string",
            "description":"Workflow configuration associated with an active application after the migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreMigCurTaskId":{
            "maxLength":1000,
            "type":"string",
            "description":"Task ID of the in-progress task belonging to the process instance associated with an active application before the migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigCurTaskStatus":{
            "maxLength":1000,
            "type":"string",
            "description":"Task status of the in-progress task belonging to the process instance associated with an active application before the migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigProcessAudit":{
            "type":"string",
            "description":"Process audit information for the process instance associated with an active application before the migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreMigProcessDtl":{
            "type":"string",
            "description":"Process details for the process instance associated with an active application before the migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreMigProcessId":{
            "maxLength":100,
            "type":"string",
            "description":"Process ID of the process instance associated with the active application before migration.",
            "nullable":false,
            "x-queryable":true
        },
        "PreMigProcessStatus":{
            "maxLength":100,
            "type":"string",
            "description":"Process status of the process instance associated with an active application before the migration.",
            "nullable":true,
            "x-queryable":true
        },
        "PreMigProcessXrefKey":{
            "type":"integer",
            "description":"Process cross-reference key identifying the process instance associated with an active application before the migration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreMigTaskDtl":{
            "type":"string",
            "description":"Task details for the in-progress task belonging to the process instance associated with an active application before the migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreMigWfConfig":{
            "type":"string",
            "description":"Workflow configuration associated with an active application before the migration.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessDefnName":{
            "maxLength":100,
            "type":"string",
            "description":"Workflow Process Definition Name associated with an active application.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"Transaction Record ID of an active application.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"Transaction Record Key of an active application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"Application Type to which an active application belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":100,
            "type":"string",
            "description":"Application Type ID to which an active application belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseHttpCode":{
            "type":"integer",
            "description":"REST response code returned by the migration activity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "RestResponse":{
            "type":"string",
            "description":"REST response returned by the migration activity.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "RetryCount":{
            "type":"integer",
            "description":"Number of retry attempts permitted to migrate an active application.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"Permitting and Licensing record sub-classification.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetWfAppVer":{
            "maxLength":50,
            "type":"string",
            "description":"Target workflow process version to which an active application is migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionInfo":{
            "type":"string",
            "description":"This column contains transaction information such as CLASSIFICATION, SUB_CLASSIFICATION, RECORD_TYPE, RECORD_TYPE_ID, APPLICANT, and VERSION_TYPE.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WfAppName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the workflow application.",
            "nullable":true,
            "x-queryable":true
        },
        "WfXrefPublishedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a migrated workflow configuration is published to the transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowType":{
            "maxLength":100,
            "type":"string",
            "description":"The workflow type to which the process instance belongs to like structured or dynamic process.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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