REST API for Common Features in Oracle Fusion Cloud Applications

Create a setup task CSV template export

post

/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports

Request

There are no request parameters for this operation.

Supported Media Types

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

Root Schema : schema

Match All

Show Source

object setupTaskCSVTemplateExports-item
object type

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

Nested Schema : setupTaskCSVTemplateExports-item

Type: object

Show Source

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.

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

Nested Schema : type

Type: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVTemplateExportProcess

Type: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

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

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

Match All

Show Source

object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupTaskCSVTemplateExportProcessResult":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
                    }
                }
            }
        }
    ]
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV template is generated.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV template 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 : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

Type: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVTemplateExportProcessResult

Type: array

Show Source

Array of: object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
    }
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-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 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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template 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 template 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 template 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 template 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":"TThe .zip file containing the setup task CSV template 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 template 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 template.",
            "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 template 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 template export process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Root Schema : schema

Match All

Show Source

object setupTaskCSVTemplateExports-item
object type

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

Nested Schema : setupTaskCSVTemplateExports-item

Type: object

Show Source

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.

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

Nested Schema : type

Type: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVTemplateExportProcess

Type: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

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

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

Match All

Show Source

object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupTaskCSVTemplateExportProcessResult":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
                    }
                }
            }
        }
    ]
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV template is generated.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV template 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 : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

Type: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVTemplateExportProcessResult

Type: array

Show Source

Array of: object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-request"
    }
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-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 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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template 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 template 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 template 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 template 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":"TThe .zip file containing the setup task CSV template 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 template 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 template.",
            "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 template 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 template export process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Root Schema : setupTaskCSVTemplateExports-item-response

Match All

Show Source

object ItemProperties
object setupTaskCSVTemplateExports-item
object setupTaskCSVTemplateExports-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVTemplateExports-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupTaskCSVTemplateExportProcess":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-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 : setupTaskCSVTemplateExports-item

Type: object

Show Source

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.

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

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

Type: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "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 : SetupTaskCSVTemplateExportProcess

Type: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response

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

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response

Match All

Show Source

object ItemProperties
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupTaskCSVTemplateExportProcessResult":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV template is generated.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV template 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 : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response-allOf[2]

Type: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response"
            }
        }
    }
}

Nested Schema : SetupTaskCSVTemplateExportProcessResult

Type: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response"
    }
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response

Match All

Show Source

object ItemProperties
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item"
        }
    ]
}

Nested Schema : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-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 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.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV template 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 template 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 template 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 template 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":"TThe .zip file containing the setup task CSV template 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 template 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 template.",
            "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 template 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 template export process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Examples

The following example shows how to create a setup task CSV template 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/setupTaskCSVTemplateExports

Example of Request Body

The following example shows the contents of the request body in JSON format:

{
  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
  "SetupTaskCSVTemplateExportProcess" : [{  "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,
    "SetupTaskCSVTemplateExportProcess": [
        {
            "ProcessId": 300100022143435,
            "TaskCode": "HZ_MANAGE_RESOURCE_ROLES",
            "ProcessCompletedFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVTemplateExportProcess/300100022143435",
                    "name": "SetupTaskCSVTemplateExportProcess",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVTemplateExportProcess/300100022143435",
                    "name": "SetupTaskCSVTemplateExportProcess",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "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/300100022143435/child/SetupTaskCSVTemplateExportProcessResult",
                    "name": "SetupTaskCSVTemplateExportProcessResult",
                    "kind": "collection"
                }
            ]
        }
    ],
    "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"
        }
    ]
}