Jump to

• Request
• Response

Get information about a migration process instance

get

/fscmRestApi/resources/11.13.18.05/publicSectorProcessMigrateActivities/{MigActivityId}

Request

Path Parameters

• MigActivityId(required): integer(int64)
  Unique identifier for the migration process instance.

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

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