Jump to

• Request
• Response

Get information about migration schedule for active applications belonging to an application type

get

/fscmRestApi/resources/11.13.18.05/publicSectorInflightMigrateSchedules/{InflightMigId}

Request

Path Parameters

• InflightMigId(required): integer(int64)
  Unique identifier for the migration schedule for active applications belonging to an application type.

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

Type: object

Show Source

• AppVersionType: string
  Maximum Length: 50

  Permitting and Licensing application version type, such as Origination, Amendment or Renewal, to which the active applications belong to.
• Classification: string
  Maximum Length: 50

  Permitting and Licensing record classification, such as Permits or Business Licenses, to which the active applications belong to.
• CurrentWfAppVer: string
  Maximum Length: 50

  Current workflow process version from which the active applications belonging to the application type are migrated from.
• ErrorDetails: string
  Maximum Length: 2000

  Details on errors encountered during migration of active applications belonging to the application type.
• ExecDuration: integer (int64)
  Time duration taken for execution of the migration schedule.
• ExecEndDate: string (date-time)
  Timestamp when execution of the migration schedule completes.
• ExecStartDate: string (date-time)
  Timestamp when execution of the migration schedule begins.
• FailedMigCount: integer (int32)
  Number of active applications belonging to the application type that failed to get migrated.
• InflightMigId: integer (int64)
  Unique identifier for the migration schedule for active applications belonging to an application type.
• InflightMigStatus: string
  Maximum Length: 30

  Indicates if the execution of the migration schedule was successful or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MigFromGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated from.
• MigJobId: integer (int32)
  Job ID which executes the migration schedule.
• MigToGenVersion: string
  Maximum Length: 10

  The OCI Process Automation Generation migrated to.
• PendingMigCount: integer (int32)
  Number of active applications belonging to the application type that are pending migration.
• ProcessDefnName: string
  Maximum Length: 100

  The workflow process definition name associated with active applications belonging to an application type.
• RecordType: string
  Maximum Length: 100

  The application type to which the active applications belong to.
• RecordTypeId: string
  Maximum Length: 100

  The application type ID to which the active applications belong to.
• SelectedAppsCount: integer (int32)
  The number of active applications belonging to the application type that are selected for migration as part of the migration schedule.
• SubClassification: string
  Maximum Length: 100

  The permitting and licensing record sub-classification to which the active applications belong to.
• SuccessMigCount: integer (int32)
  The number of active applications belonging to the application type that successfully migrated.
• TargetWfAppVer: string
  Maximum Length: 50

  The target workflow process version to which active applications belonging to the application type are migrated to.
• TotalAppsCount: integer (int32)
  Total number of active applications belonging to the application type that are eligible for migration as part of the migration schedule.
• WfAppName: string
  Maximum Length: 500

  The workflow application name associated with active applications belonging to an application type.

{
    "type":"object",
    "properties":{
        "AppVersionType":{
            "maxLength":50,
            "type":"string",
            "description":"Permitting and Licensing application version type, such as Origination, Amendment or Renewal, to which the active applications belong to.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"Permitting and Licensing record classification, such as Permits or Business Licenses, to which the active applications belong to.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentWfAppVer":{
            "maxLength":50,
            "type":"string",
            "description":"Current workflow process version from which the active applications belonging to the application type are migrated from.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorDetails":{
            "maxLength":2000,
            "type":"string",
            "description":"Details on errors encountered during migration of active applications belonging to the application type.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecDuration":{
            "type":"integer",
            "description":"Time duration taken for execution of the migration schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "ExecEndDate":{
            "type":"string",
            "description":"Timestamp when execution of the migration schedule completes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExecStartDate":{
            "type":"string",
            "description":"Timestamp when execution of the migration schedule begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FailedMigCount":{
            "type":"integer",
            "description":"Number of active applications belonging to the application type that failed to get migrated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "InflightMigId":{
            "type":"integer",
            "description":"Unique identifier for the migration schedule for active applications belonging to an application type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InflightMigStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the execution of the migration schedule was successful or not.",
            "nullable":true,
            "x-queryable":true
        },
        "MigFromGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated from.",
            "nullable":true,
            "x-queryable":true
        },
        "MigJobId":{
            "type":"integer",
            "description":"Job ID which executes the migration schedule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MigToGenVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The OCI Process Automation Generation migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "PendingMigCount":{
            "type":"integer",
            "description":"Number of active applications belonging to the application type that are pending migration.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ProcessDefnName":{
            "maxLength":100,
            "type":"string",
            "description":"The workflow process definition name associated with active applications belonging to an application type.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The application type to which the active applications belong to.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":100,
            "type":"string",
            "description":"The application type ID to which the active applications belong to.",
            "nullable":false,
            "x-queryable":true
        },
        "SelectedAppsCount":{
            "type":"integer",
            "description":"The number of active applications belonging to the application type that are selected for migration as part of the migration schedule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The permitting and licensing record sub-classification to which the active applications belong to.",
            "nullable":true,
            "x-queryable":true
        },
        "SuccessMigCount":{
            "type":"integer",
            "description":"The number of active applications belonging to the application type that successfully migrated.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TargetWfAppVer":{
            "maxLength":50,
            "type":"string",
            "description":"The target workflow process version to which active applications belonging to the application type are migrated to.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAppsCount":{
            "type":"integer",
            "description":"Total number of active applications belonging to the application type that are eligible for migration as part of the migration schedule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "WfAppName":{
            "maxLength":500,
            "type":"string",
            "description":"The workflow application name associated with active applications belonging to an application type.",
            "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