Create a setup offering CSV export
post
/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports
Create a setup offering CSV export
Request
There are no request parameters for this operation.
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Nested Schema : setupOfferingCSVExports-item
Type:
Show Source
object
-
FunctionalAreaCode: string
Title:
Functional Area Code
The unique code of the setup functional area. This attribute is required when exporting setup data for a functional area. -
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.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item
Type:
Show Source
object
-
AttributeName: string
Title:
Attribute Name
Name of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute Set
Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute Value
Value applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object Code
The unique code of the business 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. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-request
Match All
Show Source
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-request-allOf[1]
Type:
Show Source
object
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-item
Type:
Show Source
object
-
FunctionalAreaCode: string
Title:
Functional Area Code
The unique code of the setup functional area. This attribute is required when exporting setup data for a functional area. -
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.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item
Type:
Show Source
object
-
AttributeName: string
Title:
Attribute Name
Name of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute Set
Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute Value
Value applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object Code
The unique code of the business 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. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-request
Match All
Show Source
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-request-allOf[1]
Type:
Show Source
object
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.
Nested Schema : ItemProperties
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : setupOfferingCSVExports-item
Type:
Show Source
object
-
FunctionalAreaCode: string
Title:
Functional Area Code
The unique code of the setup functional area. This attribute is required when exporting setup data for a functional area. -
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.
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. -
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response
Match All
Show Source
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item
Type:
Show Source
object
-
AttributeName: string
Title:
Attribute Name
Name of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute Set
Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute Value
Value applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object Code
The unique code of the business 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. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the export process.
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response
Match All
Show Source
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 : 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.
Examples
The following example shows how to create a setup offering CSV export by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports
Example of Request Body
The following example shows the contents of the request body in JSON format:
{ "OfferingCode" : "XLE_FINANCIALS_JUR", "FunctionalAreaCode" : "ORA_ASK_ORGANIZATION_STRUCTURE", "SetupOfferingCSVExportCriteria" : [ { "OfferingCode" : "XLE_FINANCIALS_JUR" , "BusinessObjectCode": "FUN_BUSINESS_UNIT", "AttributeSet" : "Set1", "AttributeName" : "OrganizationCode", "AttributeValue" : "ANBU4$$?$$FUN_BUSINESS_UNIT1" } ], "SetupOfferingCSVExportProcess" : [{ "OfferingCode" : "XLE_FINANCIALS_JUR"}] }
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
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "OfferingCode": "XLE_FINANCIALS_JUR", "FunctionalAreaCode": "ORA_ASK_ORGANIZATION_STRUCTURE", "SetupOfferingCSVExportCriteria": [ { "OfferingCode": "XLE_FINANCIALS_JUR", "ProcessId": null, "BusinessObjectCode": "FUN_BUSINESS_UNIT", "AttributeSet": "Set1", "AttributeName": "OrganizationCode", "AttributeValue": "ANBU4$$?$$FUN_BUSINESS_UNIT1", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVExportCriteria/000400000012584C455F46494E414E4349414C535F4A55520000001146554E5F425553494E4553535F554E49540000000453657431000000104F7267616E697A6174696F6E436F6465", "name": "SetupOfferingCSVExportCriteria", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVExportCriteria/000400000012584C455F46494E414E4349414C535F4A55520000001146554E5F425553494E4553535F554E49540000000453657431000000104F7267616E697A6174696F6E436F6465", "name": "SetupOfferingCSVExportCriteria", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVExports", "kind": "item" } ] } ], "SetupOfferingCSVExportProcess": [ { "ProcessId": 300100068271744, "OfferingCode": "XLE_FINANCIALS_JUR", "ProcessCompletedFlag": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVExportProcess/300100068271744", "name": "SetupOfferingCSVExportProcess", "kind": "item" }, ... ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVExports", "kind": "item" }, ... ] }