Create an export process
post
/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/{OfferingCode}/child/SetupOfferingCSVExportProcess
Create an export process
Request
Path Parameters
-
OfferingCode(required): string
The short code of the setup offering. This attribute is required.
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type:
Show Source
object
-
CSVTemplateReport: string
(byte)
Title:
CSV Template Report
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The packaged file containing the CSV template report files. -
FileContent: string
(byte)
Title:
File Content
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The .zip file containing the setup offering CSV files. -
FileName: string
Title:
File Name
The name of the packaged file containing the setup offering -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process result. -
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. -
ProcessName: string
Title:
Process Name
Name of the export 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 offering or functional area included in the export 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 export process. -
StatusCode: string
Title:
Status Code
The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type:
Show Source
object
-
CSVTemplateReport: string
(byte)
Title:
CSV Template Report
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The packaged file containing the CSV template report files. -
FileContent: string
(byte)
Title:
File Content
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The .zip file containing the setup offering CSV files. -
FileName: string
Title:
File Name
The name of the packaged file containing the setup offering -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process result. -
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. -
ProcessName: string
Title:
Process Name
Name of the export 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 offering or functional area included in the export 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 export process. -
StatusCode: string
Title:
Status Code
The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.
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 : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response
Match All
Show Source
Nested Schema : ItemProperties
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response-allOf[2]
Type:
Show Source
object
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response
Match All
Show Source
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type:
Show Source
object
-
CSVTemplateReport: string
(byte)
Title:
CSV Template Report
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The packaged file containing the CSV template report files. -
FileContent: string
(byte)
Title:
File Content
Read Only:true
Pattern:^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
The .zip file containing the setup offering CSV files. -
FileName: string
Title:
File Name
The name of the packaged file containing the setup offering -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process result. -
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. -
ProcessName: string
Title:
Process Name
Name of the export 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 offering or functional area included in the export 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 export process. -
StatusCode: string
Title:
Status Code
The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.