Create a setup task CSV export
post
/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports
Request
There are no request parameters for this operation.
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Nested Schema : setupTaskCSVExports-item
Type:
Show Source
object
-
ExportSupportedFlag: string
Title:
Export to CSV Support
Indicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task Code
Maximum Length:255
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-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 used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type:
Show Source
object
-
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the setup task CSV export 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 export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type:
Show Source
object
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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 task CSV export. -
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 task CSV files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export 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 export process. -
ProcessName: string
Title:
Process Name
Name of the setup task CSV 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 task included in the CSV 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 task CSV export process. -
StatusCode: string
Title:
Status Code
The status of the setup task CSV export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.
Nested Schema : setupTaskCSVExports-item
Type:
Show Source
object
-
ExportSupportedFlag: string
Title:
Export to CSV Support
Indicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task Code
Maximum Length:255
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-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 used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type:
Show Source
object
-
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the setup task CSV export 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 export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type:
Show Source
object
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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 task CSV export. -
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 task CSV files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export 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 export process. -
ProcessName: string
Title:
Process Name
Name of the setup task CSV 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 task included in the CSV 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 task CSV export process. -
StatusCode: string
Title:
Status Code
The status of the setup task CSV 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 : setupTaskCSVExports-item
Type:
Show Source
object
-
ExportSupportedFlag: string
Title:
Export to CSV Support
Indicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task Code
Maximum Length:255
The unique code of the setup task for which the CSV file is generated.
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 : setupTaskCSVExports-SetupTaskCSVExportCriteria-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 used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type:
Show Source
object
-
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the setup task CSV export 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 export process. -
TaskCode: string
Title:
Task Code
The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response-allOf[2]
Type:
Show Source
object
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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 task CSV export. -
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 task CSV files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV export 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 export process. -
ProcessName: string
Title:
Process Name
Name of the setup task CSV 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 task included in the CSV 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 task CSV export process. -
StatusCode: string
Title:
Status Code
The status of the setup task CSV 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 task 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/setupTaskCSVExports
Example of Request Body
The following example shows the contents of the request body in JSON format:
{ "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES", "SetupTaskCSVExportCriteria" : [ { "TaskCode" :"HZ_MANAGE_RESOURCE_ROLES" , "BusinessObjectCode": "JTF_RS_ROLES_B", "AttributeSet" : "Set1", "AttributeName" : "RoleTypeCode", "AttributeValue" : "CHANNEL_SALES" } ], "SetupTaskCSVExportProcess" : [{ "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES" }] }
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:
{ "TaskCode": "HZ_MANAGE_RESOURCE_ROLES", "ExportSupportedFlag": null, "SetupTaskCSVExportProcess": [ { "ProcessId": 300100022143402, "TaskCode": "HZ_MANAGE_RESOURCE_ROLES", "ProcessCompletedFlag": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportProcess/300100022143402", "name": "SetupTaskCSVExportProcess", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportProcess/300100022143402", "name": "SetupTaskCSVExportProcess", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportProcess/300100022143402/child/SetupTaskCSVExportProcessResult", "name": "SetupTaskCSVExportProcessResult", "kind": "collection" } ] } ], "SetupTaskCSVExportCriteria": [ { "TaskCode": "HZ_MANAGE_RESOURCE_ROLES", "ProcessId": null, "BusinessObjectCode": "JTF_RS_ROLES_B", "AttributeSet": "Set1", "AttributeName": "RoleTypeCode", "AttributeValue": "CHANNEL_SALES", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportCriteria/HZ_MANAGE_RESOURCE_ROLES", "name": "SetupTaskCSVExportCriteria", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportCriteria/HZ_MANAGE_RESOURCE_ROLES", "name": "SetupTaskCSVExportCriteria", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVExports", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVExports", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportProcess", "name": "SetupTaskCSVExportProcess", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportCriteria", "name": "SetupTaskCSVExportCriteria", "kind": "collection" } ] }