1. REST API for Common Features in Oracle Fusion Cloud Applications
  2. Tasks
  3. Setup Task CSV Exports

Get a setup task CSV export

get

/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/{TaskCode}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • The resource item payload will be filtered in order to contain only data (no links section, for example).

There's no request body for this operation.

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 : schema
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 retrieve a setup task CSV export by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/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": true, "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