Create a setup offering CSV template export
post
/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports
Create a setup offering CSV template export
Request
There are no request parameters for this operation.
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Nested Schema : setupOfferingCSVTemplateExports-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 offering CSV template for a functional area. -
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request
Match All
Show Source
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering for which the CSV template is generated. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute does not have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template export process.
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]
Type:
Show Source
object
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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 .zip file containing the template report files for the setup offering CSV template. -
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 template files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup offering CSV template files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template 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 in the setup offering CSV template export process. -
ProcessName: string
Title:
Process Name
Name of the setup offering CSV template 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 CSV template 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 setup offering CSV template 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 : setupOfferingCSVTemplateExports-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 offering CSV template for a functional area. -
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request
Match All
Show Source
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering for which the CSV template is generated. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute does not have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template export process.
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]
Type:
Show Source
object
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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 .zip file containing the template report files for the setup offering CSV template. -
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 template files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup offering CSV template files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template 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 in the setup offering CSV template export process. -
ProcessName: string
Title:
Process Name
Name of the setup offering CSV template 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 CSV template 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 setup offering CSV template 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 : setupOfferingCSVTemplateExports-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 offering CSV template for a functional area. -
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.
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 : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response
Match All
Show Source
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
Type:
Show Source
object
-
OfferingCode: string
Title:
Offering Code
The unique code of the setup offering for which the CSV template is generated. -
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the export process is complete. This attribute does not have a default value. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template export process.
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response-allOf[2]
Type:
Show Source
object
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response
Match All
Show Source
Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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 .zip file containing the template report files for the setup offering CSV template. -
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 template files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup offering CSV template files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup offering CSV template 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 in the setup offering CSV template export process. -
ProcessName: string
Title:
Process Name
Name of the setup offering CSV template 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 CSV template 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 setup offering CSV template 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 template 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/setupOfferingCSVTemplateExports
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", "SetupOfferingCSVTemplateExportProcess" : [{ "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", "SetupOfferingCSVTemplateExportProcess": [ { "ProcessId": 300100068274827, "OfferingCode": "XLE_FINANCIALS_JUR", "ProcessCompletedFlag": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827/child/SetupOfferingCSVTemplateExportProcessResult", "name": "SetupOfferingCSVTemplateExportProcessResult", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "collection" } ] }