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 CodeThe 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 CompleteIndicates whether the export process is complete. This attribute doesn't have a default value. - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type:
Show Source object- CSVTemplateReport: string (byte) Title:
CSV Template ReportRead Only:truePattern:^(?:[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 ContentRead Only:truePattern:^(?:[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 NameThe name of the packaged file containing the setup offering - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process result. - ProcessLog: string (byte) Title:
Process LogRead Only:truePattern:^(?:[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 NameName of the export process. - ProcessResultsReport: string (byte) Title:
Process Results ReportRead Only:truePattern:^(?:[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 ReportRead Only:truePattern:^(?:[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 CodeThe 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 CodeThe 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 CompleteIndicates whether the export process is complete. This attribute doesn't have a default value. - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type:
Show Source object- CSVTemplateReport: string (byte) Title:
CSV Template ReportRead Only:truePattern:^(?:[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 ContentRead Only:truePattern:^(?:[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 NameThe name of the packaged file containing the setup offering - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process result. - ProcessLog: string (byte) Title:
Process LogRead Only:truePattern:^(?:[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 NameName of the export process. - ProcessResultsReport: string (byte) Title:
Process Results ReportRead Only:truePattern:^(?:[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 ReportRead Only:truePattern:^(?:[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 CodeThe 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:
LinksThe link relations associated with the resource instance.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item
Type:
Show Source object- OfferingCode: string Title:
Offering CodeThe 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 CompleteIndicates whether the export process is complete. This attribute doesn't have a default value. - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response-allOf[2]
Type:
Show Source objectNested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object- changeIndicator: string Change indicator or the ETag value of the resource instance.
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 ReportRead Only:truePattern:^(?:[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 ContentRead Only:truePattern:^(?:[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 NameThe name of the packaged file containing the setup offering - ProcessId: integer (int32) Title:
Process IDThe unique identifier of the export process result. - ProcessLog: string (byte) Title:
Process LogRead Only:truePattern:^(?:[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 NameName of the export process. - ProcessResultsReport: string (byte) Title:
Process Results ReportRead Only:truePattern:^(?:[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 ReportRead Only:truePattern:^(?:[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 CodeThe status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.