REST API for Common Features in Oracle Fusion Cloud Applications

Get an import process

get

/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/{TaskCode}/child/SetupTaskCSVImportProcess/{ProcessId}

Request

Path Parameters

ProcessId(required): string

The identifier of the import process. This attribute is required.
TaskCode(required): string

The short code of the setup task. This attribute is required.

Query Parameters

dependency: string

This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

There's no request body for this operation.

Response

Supported Media Types

application/vnd.oracle.adf.resourceitem+json
application/json

Default Response

The following table describes the default response for this task.

Root Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item-response

Match All

Show Source

object ItemProperties
object setupTaskCSVImports-SetupTaskCSVImportProcess-item
object setupTaskCSVImports-SetupTaskCSVImportProcess-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupTaskCSVImportProcessResult":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item

Type: object

Show Source

FileContent: string (byte)

Title: File Content

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

The .zip file containing the setup task CSV files.
ProcessCompletedFlag: string

Title: Process Complete

Indicates whether the setup task CSV import process is complete. This attribute doesn't have a default value.
ProcessId: integer (int32)

Title: Process ID

The unique identifier of the setup task CSV import process.
SourceTargetDiffOkFlag: string

Title: Option to Import Task Setup Data Although Revisions Mismatch

Indicates an option to proceed with the import even if the revision of the imported task setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.
TaskCode: string

Title: Task Code

The unique identifier of the setup task CSV import process.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "type":"string",
            "description":"The unique identifier of the setup task CSV import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "FileContent":{
            "title":"File Content",
            "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
            "type":"string",
            "description":"The .zip file containing the setup task CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV import process is complete. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Task Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported task setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item-response-allOf[2]

Type: object

Show Source

SetupTaskCSVImportProcessResult: array SetupTaskCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response"
            }
        }
    }
}

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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "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."
        }
    }
}

Nested Schema : SetupTaskCSVImportProcessResult

Type: array

Show Source

Array of: setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response"
    }
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response

Match All

Show Source

object ItemProperties
object setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item"
        }
    ]
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

Type: object

Show Source

ProcessId: integer (int32)

Title: Process ID

The unique identifier of the setup task CSV import process.
ProcessLog: string (byte)

Title: Process Log

Read Only: true

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

The log containing the processing details of each business object in the setup task CSV import process.
ProcessName: string

Title: Process Name

Name of the setup task CSV import process.
ProcessResultsReport: string (byte)

Title: Process Results Report

Read Only: true

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

The report that contains the results for each business object of the task included in the CSV import process.
ProcessResultsSummaryReport: string (byte)

Title: Process Results Summary Report

Read Only: true

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

The summary report for the setup task CSV import process.
StatusCode: string

Title: Status Code

The status of the setup task CSV import process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup task CSV import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the setup task CSV import process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessLog":{
            "title":"Process Log",
            "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
            "type":"string",
            "description":"The log containing the processing details of each business object in the setup task CSV import process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessResultsReport":{
            "title":"Process Results Report",
            "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
            "type":"string",
            "description":"The report that contains the results for each business object of the task included in the CSV import process. ",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessResultsSummaryReport":{
            "title":"Process Results Summary Report",
            "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
            "type":"string",
            "description":"The summary report for the setup task CSV import process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Examples

The following example shows how to retrieve an import process for a given process identifier by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100032652316

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json
               application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "ProcessId" : 300100032652316,
 "TaskCode" : null, 
 "ProcessCompletedFlag" : true,
 .
 .
 .
}