Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object setupTaskCSVExports-item
• object type

{ "allOf":[ { "$ref":"#/components/schemas/setupTaskCSVExports-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } } } } ] }

Nested Schema : setupTaskCSVExports-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "maxLength":255, "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ExportSupportedFlag":{ "title":"Export to CSV Support", "type":"string", "description":"Indicates whether CSV export is supported for the setup task.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : type

Type: object

Show Source

• SetupTaskCSVExportCriteria: array SetupTaskCSVExportCriteria
• SetupTaskCSVExportProcess: array SetupTaskCSVExportProcess

{ "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } } } }

Nested Schema : SetupTaskCSVExportCriteria

Type: array

Show Source

• Array of: object setupTaskCSVExports-SetupTaskCSVExportCriteria-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } }

Nested Schema : SetupTaskCSVExportProcess

Type: array

Show Source

• Array of: setupTaskCSVExports-SetupTaskCSVExportProcess-item-request

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object used to define the filter criteria.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request

Match All

Show Source

• object setupTaskCSVExports-SetupTaskCSVExportProcess-item
• object setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } } } } ] }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the setup task CSV export process is complete. This attribute doesn't have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupTaskCSVExportProcessResult: array SetupTaskCSVExportProcessResult

{ "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } } } }

Nested Schema : SetupTaskCSVExportProcessResult

Type: array

Show Source

• Array of: object setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup task CSV export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the setup task CSV export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup task CSV files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup task CSV files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup task CSV export.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the task included in the CSV export process. ", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Match All

Show Source

• object setupTaskCSVExports-item
• object type

{ "allOf":[ { "$ref":"#/components/schemas/setupTaskCSVExports-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } } } } ] }

Nested Schema : setupTaskCSVExports-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "maxLength":255, "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ExportSupportedFlag":{ "title":"Export to CSV Support", "type":"string", "description":"Indicates whether CSV export is supported for the setup task.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : type

Type: object

Show Source

• SetupTaskCSVExportCriteria: array SetupTaskCSVExportCriteria
• SetupTaskCSVExportProcess: array SetupTaskCSVExportProcess

{ "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } } } }

Nested Schema : SetupTaskCSVExportCriteria

Type: array

Show Source

• Array of: object setupTaskCSVExports-SetupTaskCSVExportCriteria-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-request" } }

Nested Schema : SetupTaskCSVExportProcess

Type: array

Show Source

• Array of: setupTaskCSVExports-SetupTaskCSVExportProcess-item-request

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-request" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object used to define the filter criteria.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request

Match All

Show Source

• object setupTaskCSVExports-SetupTaskCSVExportProcess-item
• object setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } } } } ] }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the setup task CSV export process is complete. This attribute doesn't have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupTaskCSVExportProcessResult: array SetupTaskCSVExportProcessResult

{ "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } } } }

Nested Schema : SetupTaskCSVExportProcessResult

Type: array

Show Source

• Array of: object setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-request" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup task CSV export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the setup task CSV export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup task CSV files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup task CSV files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup task CSV export.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the task included in the CSV export process. ", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : setupTaskCSVExports-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVExports-item
• object setupTaskCSVExports-item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupTaskCSVExports-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-response" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response" } } } } ] }

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } } } }

Nested Schema : setupTaskCSVExports-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "maxLength":255, "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ExportSupportedFlag":{ "title":"Export to CSV Support", "type":"string", "description":"Indicates whether CSV export is supported for the setup task.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupTaskCSVExports-item-response-allOf[2]

Type: object

Show Source

• SetupTaskCSVExportCriteria: array SetupTaskCSVExportCriteria
• SetupTaskCSVExportProcess: array SetupTaskCSVExportProcess

{ "type":"object", "properties":{ "SetupTaskCSVExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-response" } }, "SetupTaskCSVExportCriteria":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response" } } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Nested Schema : link

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Nested Schema : SetupTaskCSVExportCriteria

Type: array

Show Source

• Array of: setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response" } }

Nested Schema : SetupTaskCSVExportProcess

Type: array

Show Source

• Array of: setupTaskCSVExports-SetupTaskCSVExportProcess-item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item-response" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVExports-SetupTaskCSVExportCriteria-item

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportCriteria-item" } ] }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportCriteria-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "BusinessObjectCode":{ "title":"Business Object Code", "type":"string", "description":"The unique code of the business object used to define the filter criteria.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeSet":{ "title":"Attribute Set", "type":"string", "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeName":{ "title":"Attribute Name", "type":"string", "description":"Name of the attribute that defines the filter criteria for the business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "AttributeValue":{ "title":"Attribute Value", "type":"string", "description":"Value applicable to the attribute that defines the filter criteria for a business object.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVExports-SetupTaskCSVExportProcess-item
• object setupTaskCSVExports-SetupTaskCSVExportProcess-item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-item" }, { "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response" } } } } ] }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "TaskCode":{ "title":"Task Code", "type":"string", "description":"The unique code of the setup task for which the CSV file is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the setup task CSV export process is complete. This attribute doesn't have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response-allOf[2]

Type: object

Show Source

• SetupTaskCSVExportProcessResult: array SetupTaskCSVExportProcessResult

{ "type":"object", "properties":{ "SetupTaskCSVExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response" } } } }

Nested Schema : SetupTaskCSVExportProcessResult

Type: array

Show Source

• Array of: setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response" } }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item" } ] }

Nested Schema : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup task CSV export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup task CSV export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the setup task CSV export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup task CSV files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup task CSV files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup task CSV export.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the task included in the CSV export process. ", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup task CSV export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

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