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
Request Body - application/json ()
Root Schema : schema
Match All
Show Source
Nested Schema : setupTaskCSVExports-item
Type: object
Show Source
  • Title: Export to CSV Support
    Indicates whether CSV export is supported for the setup task.
  • Title: Task Code
    Maximum Length: 255
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : type
Type: object
Show Source
Nested Schema : SetupTaskCSVExportCriteria
Type: array
Show Source
Nested Schema : SetupTaskCSVExportProcess
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item
Type: object
Show Source
  • Title: Attribute Name
    Name of the attribute that defines the filter criteria for the business object.
  • Title: Attribute Set
    Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
  • Title: Attribute Value
    Value applicable to the attribute that defines the filter criteria for a business object.
  • Title: Business Object Code
    The unique code of the business object used to define the filter criteria.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • Title: Task Code
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type: object
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type: object
Show Source
Nested Schema : SetupTaskCSVExportProcessResult
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item
Type: object
Show Source
  • 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.
  • 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.
  • Title: File Name
    The name of the .zip file containing the setup task CSV files.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • 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.
  • Title: Process Name
    Name of the setup task CSV export process.
  • 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.
  • 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.
  • 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.
Request Body - application/vnd.oracle.adf.resourceitem+json ()
Root Schema : schema
Match All
Show Source
Nested Schema : setupTaskCSVExports-item
Type: object
Show Source
  • Title: Export to CSV Support
    Indicates whether CSV export is supported for the setup task.
  • Title: Task Code
    Maximum Length: 255
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : type
Type: object
Show Source
Nested Schema : SetupTaskCSVExportCriteria
Type: array
Show Source
Nested Schema : SetupTaskCSVExportProcess
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item
Type: object
Show Source
  • Title: Attribute Name
    Name of the attribute that defines the filter criteria for the business object.
  • Title: Attribute Set
    Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
  • Title: Attribute Value
    Value applicable to the attribute that defines the filter criteria for a business object.
  • Title: Business Object Code
    The unique code of the business object used to define the filter criteria.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • Title: Task Code
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type: object
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]
Type: object
Show Source
Nested Schema : SetupTaskCSVExportProcessResult
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item
Type: object
Show Source
  • 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.
  • 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.
  • Title: File Name
    The name of the .zip file containing the setup task CSV files.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • 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.
  • Title: Process Name
    Name of the setup task CSV export process.
  • 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.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : setupTaskCSVExports-item-response
Match All
Show Source
Nested Schema : ItemProperties
Type: object
Show Source
Nested Schema : setupTaskCSVExports-item
Type: object
Show Source
  • Title: Export to CSV Support
    Indicates whether CSV export is supported for the setup task.
  • Title: Task Code
    Maximum Length: 255
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-item-response-allOf[2]
Type: object
Show Source
Nested Schema : SetupTaskCSVExportCriteria
Type: array
Show Source
Nested Schema : SetupTaskCSVExportProcess
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item
Type: object
Show Source
  • Title: Attribute Name
    Name of the attribute that defines the filter criteria for the business object.
  • Title: Attribute Set
    Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
  • Title: Attribute Value
    Value applicable to the attribute that defines the filter criteria for a business object.
  • Title: Business Object Code
    The unique code of the business object used to define the filter criteria.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • Title: Task Code
    The unique code of the setup task for which the CSV file is generated.
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item
Type: object
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response-allOf[2]
Type: object
Show Source
Nested Schema : SetupTaskCSVExportProcessResult
Type: array
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response
Match All
Show Source
Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item
Type: object
Show Source
  • 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.
  • 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.
  • Title: File Name
    The name of the .zip file containing the setup task CSV files.
  • Title: Process ID
    The unique identifier of the setup task CSV export process.
  • 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.
  • Title: Process Name
    Name of the setup task CSV export process.
  • 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.
  • 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.
  • 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.
Back to Top

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" } ] }
Back to Top