Get a setup task CSV template export
get
/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports/{TaskCode}
Request
Path Parameters
-
TaskCode(required): string
The short code of the setup task. This attribute is required.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
onlyData: boolean
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 TopResponse
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 : setupTaskCSVTemplateExports-item
Type:
Show Source
object
-
ExportSupportedFlag: string
Title:
Export to CSV Support
Indicates whether export to CSV file format is supported for this task setup data. This attribute does not have a default value. -
TaskCode: string
Title:
Task Code
Maximum Length:255
The unique code of the setup task for which the CSV template 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. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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 : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response
Match All
Show Source
Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item
Type:
Show Source
object
-
ProcessCompletedFlag: string
Title:
Process Complete
Indicates whether the setup task CSV template 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 template export process. -
TaskCode: string
Title:
Task Code
Maximum Length:255
The unique code of the setup task for which the CSV template is generated.
Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response-allOf[2]
Type:
Show Source
object
Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response
Match All
Show Source
Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-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 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}=)?$
TThe .zip file containing the setup task CSV template files. -
FileName: string
Title:
File Name
The name of the .zip file containing the setup task CSV template files. -
ProcessId: integer
(int32)
Title:
Process ID
The unique identifier of the setup task CSV template 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 template export process. -
ProcessName: string
Title:
Process Name
Name of the setup task 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 task 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 task CSV template export process. -
StatusCode: string
Title:
Status Code
The status of the setup task CSV template export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.
Examples
The following example shows how to retrieve a setup task CSV template 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/setupTaskCSVTemplateExports/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/setupTaskCSVTemplateExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVTemplateExports", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports/HZ_MANAGE_RESOURCE_ROLES", "name": "setupTaskCSVTemplateExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVTemplateExportProcess", "name": "SetupTaskCSVTemplateExportProcess", "kind": "collection" } ] }