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 SupportIndicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task CodeMaximum Length:255The 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 NameName of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute SetName of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute ValueValue applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object CodeThe unique code of the business object used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe 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 CompleteIndicates whether the setup task CSV export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type:
Show Source
objectNested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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 .zip file containing the template report files for the setup task CSV export. -
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 task CSV files. -
FileName: string
Title:
File NameThe name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
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 in the setup task CSV export process. -
ProcessName: string
Title:
Process NameName of the setup task CSV 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 task included in the CSV 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 setup task CSV export process. -
StatusCode: string
Title:
Status CodeThe 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 SupportIndicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task CodeMaximum Length:255The 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 NameName of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute SetName of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute ValueValue applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object CodeThe unique code of the business object used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe 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 CompleteIndicates whether the setup task CSV export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type:
Show Source
objectNested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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 .zip file containing the template report files for the setup task CSV export. -
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 task CSV files. -
FileName: string
Title:
File NameThe name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
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 in the setup task CSV export process. -
ProcessName: string
Title:
Process NameName of the setup task CSV 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 task included in the CSV 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 setup task CSV export process. -
StatusCode: string
Title:
Status CodeThe 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:
LinksThe link relations associated with the resource instance.
Nested Schema : setupTaskCSVExports-item
Type:
Show Source
object-
ExportSupportedFlag: string
Title:
Export to CSV SupportIndicates whether CSV export is supported for the setup task. -
TaskCode: string
Title:
Task CodeMaximum Length:255The unique code of the setup task for which the CSV file is generated.
Nested 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 : setupTaskCSVExports-SetupTaskCSVExportCriteria-item
Type:
Show Source
object-
AttributeName: string
Title:
Attribute NameName of the attribute that defines the filter criteria for the business object. -
AttributeSet: string
Title:
Attribute SetName of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition. -
AttributeValue: string
Title:
Attribute ValueValue applicable to the attribute that defines the filter criteria for a business object. -
BusinessObjectCode: string
Title:
Business Object CodeThe unique code of the business object used to define the filter criteria. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe 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 CompleteIndicates whether the setup task CSV export process is complete. This attribute doesn't have a default value. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
TaskCode: string
Title:
Task CodeThe unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response-allOf[2]
Type:
Show Source
objectNested 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 ReportRead Only:truePattern:^(?:[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 ContentRead Only:truePattern:^(?:[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 NameThe name of the .zip file containing the setup task CSV files. -
ProcessId: integer
(int32)
Title:
Process IDThe unique identifier of the setup task CSV export process. -
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 in the setup task CSV export process. -
ProcessName: string
Title:
Process NameName of the setup task CSV 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 task included in the CSV 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 setup task CSV export process. -
StatusCode: string
Title:
Status CodeThe 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/jsonExample 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"
}
]
}