Oracle Fusion Cloud Applications共通機能のためのREST API

機械翻訳について

設定タスクのCSVテンプレート・エクスポートの作成

post

/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ

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

ルート・スキーマ : schema

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : setupTaskCSVTemplateExports-item

タイプ: object

Show Source

ExportSupportedFlag: string

タイトル: Export to CSV Support

このタスク設定データに対してCSVファイル形式へのエクスポートがサポートされているかどうかを示します。この属性にはデフォルト値がありません。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : type

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcess

タイプ: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

タイプ: object

Show Source

ProcessCompletedFlag: string

タイトル: Process Complete

設定タスクCSVテンプレート・エクスポート・プロセスが完了しているかどうかを示します。この属性にデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcessResult

タイプ: array

Show Source

Array of: object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

タイプ: object

Show Source

CSVTemplateReport: string (byte)

タイトル: CSV Template Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレートのテンプレート・レポート・ファイルを含む.zipファイル。
FileContent: string (byte)

タイトル: File Content

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

TThe設定タスクCSVテンプレート・ファイルを含む.zipファイル。
FileName: string

タイトル: File Name

設定タスクCSVテンプレート・ファイルを含む.zipファイルの名前。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
ProcessLog: string (byte)

タイトル: Process Log

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの各ビジネス・オブジェクトの処理詳細を含むログ。
ProcessName: string

タイトル: Process Name

設定タスクCSVテンプレート・エクスポート・プロセスの名前。
ProcessResultsReport: string (byte)

タイトル: Process Results Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

CSVテンプレート・エクスポート・プロセスに含まれているタスクの各ビジネス・オブジェクトの結果を含むレポート。
ProcessResultsSummaryReport: string (byte)

タイトル: Process Results Summary Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの要約レポート。
StatusCode: string

タイトル: Status Code

設定タスクCSVテンプレート・エクスポート・プロセスのステータス。有効な値は、NOT_STARTED、IN_PROGRESS、COMPLETED、COMPLETED_WARNINGSおよび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
            }
        }
    }
}

ルート・スキーマ : schema

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : setupTaskCSVTemplateExports-item

タイプ: object

Show Source

ExportSupportedFlag: string

タイトル: Export to CSV Support

このタスク設定データに対してCSVファイル形式へのエクスポートがサポートされているかどうかを示します。この属性にはデフォルト値がありません。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : type

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcess

タイプ: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

タイプ: object

Show Source

ProcessCompletedFlag: string

タイトル: Process Complete

設定タスクCSVテンプレート・エクスポート・プロセスが完了しているかどうかを示します。この属性にデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-request-allOf[1]

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcessResult

タイプ: array

Show Source

Array of: object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

タイプ: object

Show Source

CSVTemplateReport: string (byte)

タイトル: CSV Template Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレートのテンプレート・レポート・ファイルを含む.zipファイル。
FileContent: string (byte)

タイトル: File Content

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

TThe設定タスクCSVテンプレート・ファイルを含む.zipファイル。
FileName: string

タイトル: File Name

設定タスクCSVテンプレート・ファイルを含む.zipファイルの名前。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
ProcessLog: string (byte)

タイトル: Process Log

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの各ビジネス・オブジェクトの処理詳細を含むログ。
ProcessName: string

タイトル: Process Name

設定タスクCSVテンプレート・エクスポート・プロセスの名前。
ProcessResultsReport: string (byte)

タイトル: Process Results Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

CSVテンプレート・エクスポート・プロセスに含まれているタスクの各ビジネス・オブジェクトの結果を含むレポート。
ProcessResultsSummaryReport: string (byte)

タイトル: Process Results Summary Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの要約レポート。
StatusCode: string

タイトル: Status Code

設定タスクCSVテンプレート・エクスポート・プロセスのステータス。有効な値は、NOT_STARTED、IN_PROGRESS、COMPLETED、COMPLETED_WARNINGSおよび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
            }
        }
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

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

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。

ルート・スキーマ : setupTaskCSVTemplateExports-item-response

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : ItemProperties

タイプ: object

Show Source

links: array Links

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

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

ネストされたスキーマ : setupTaskCSVTemplateExports-item

タイプ: object

Show Source

ExportSupportedFlag: string

タイトル: Export to CSV Support

このタスク設定データに対してCSVファイル形式へのエクスポートがサポートされているかどうかを示します。この属性にはデフォルト値がありません。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : setupTaskCSVTemplateExports-item-response-allOf[2]

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcess: array SetupTaskCSVTemplateExportProcess

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

Show Source

href: string

タイトル: hyperlink reference

関連付けられたリソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連付けられたリソースの種類。
name: string

タイトル: name

関連付けられたリソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

Show Source

changeIndicator: string

リソース・インスタンスの変更インジケータまたはETagの値。

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcess

タイプ: array

Show Source

Array of: setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response

すべてに一致

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"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item

タイプ: object

Show Source

ProcessCompletedFlag: string

タイトル: Process Complete

設定タスクCSVテンプレート・エクスポート・プロセスが完了しているかどうかを示します。この属性にデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
TaskCode: string

タイトル: Task Code

最大長: 255

CSVテンプレートが生成される設定タスクの一意のコード。

{
    "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"
                }
            }
        }
    }
}

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-item-response-allOf[2]

タイプ: object

Show Source

SetupTaskCSVTemplateExportProcessResult: array SetupTaskCSVTemplateExportProcessResult

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

ネストされたスキーマ : SetupTaskCSVTemplateExportProcessResult

タイプ: array

Show Source

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

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item-response

すべてに一致

Show Source

object ItemProperties
object setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

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

ネストされたスキーマ : setupTaskCSVTemplateExports-SetupTaskCSVTemplateExportProcess-SetupTaskCSVTemplateExportProcessResult-item

タイプ: object

Show Source

CSVTemplateReport: string (byte)

タイトル: CSV Template Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレートのテンプレート・レポート・ファイルを含む.zipファイル。
FileContent: string (byte)

タイトル: File Content

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

TThe設定タスクCSVテンプレート・ファイルを含む.zipファイル。
FileName: string

タイトル: File Name

設定タスクCSVテンプレート・ファイルを含む.zipファイルの名前。
ProcessId: integer (int32)

タイトル: Process ID

設定タスクCSVテンプレート・エクスポート・プロセスの一意識別子。
ProcessLog: string (byte)

タイトル: Process Log

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの各ビジネス・オブジェクトの処理詳細を含むログ。
ProcessName: string

タイトル: Process Name

設定タスクCSVテンプレート・エクスポート・プロセスの名前。
ProcessResultsReport: string (byte)

タイトル: Process Results Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

CSVテンプレート・エクスポート・プロセスに含まれているタスクの各ビジネス・オブジェクトの結果を含むレポート。
ProcessResultsSummaryReport: string (byte)

タイトル: Process Results Summary Report

読取り専用: true

パターン : ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

設定タスクCSVテンプレート・エクスポート・プロセスの要約レポート。
StatusCode: string

タイトル: Status Code

設定タスクCSVテンプレート・エクスポート・プロセスのステータス。有効な値は、NOT_STARTED、IN_PROGRESS、COMPLETED、COMPLETED_WARNINGSおよび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
            }
        }
    }
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、設定タスクのCSVテンプレート・エクスポートを作成する方法を示しています。

curl -i -u "<username>:<password>" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVTemplateExports

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています:

{
  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
  "SetupTaskCSVTemplateExportProcess" : [{  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES"}]
 }

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json
               application/json

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
    "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"
        }
    ]
}

「トップに戻る」