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

機械翻訳について

設定オファリングCSVテンプレート・エクスポートの作成

post

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports

設定オファリングCSVテンプレート・エクスポートの作成

リクエスト

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

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

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

ルート・スキーマ : schema

すべてに一致

Show Source

object setupOfferingCSVTemplateExports-item
object type

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

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

タイプ: object

Show Source

FunctionalAreaCode: string

タイトル: Functional Area Code

設定機能領域の一意のコード。この属性は、機能領域の設定オファリングCSVテンプレートをエクスポートする場合に必要です。
OfferingCode: string

タイトル: Offering Code

設定オファリングの一意のコード。この属性は、オファリングの設定オファリングCSVテンプレートをエクスポートする場合に必要です。

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "FunctionalAreaCode":{
            "title":"Functional Area Code",
            "type":"string",
            "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

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

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

タイプ: array

Show Source

Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

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

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

すべてに一致

Show Source

object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

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

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

タイプ: object

Show Source

OfferingCode: string

タイトル: Offering Code

CSVテンプレートが生成される設定オファリングの一意のコード。
ProcessCompletedFlag: string

タイトル: Process Complete

エクスポート・プロセスが完了したかどうかを示します。この属性にはデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定オファリングCSVテンプレート・エクスポート・プロセスの一意識別子。

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup offering CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering 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 export process is complete. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request"
            }
        }
    }
}

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

タイプ: array

Show Source

Array of: object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request"
    }
}

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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}=)?$

設定オファリング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

エクスポート・プロセスのステータス。有効な値は、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 offering CSV template export process result.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup offering CSV template export process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the 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 offering 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":"The .zip file containing the setup offering 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 offering 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 offering 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 offering or functional area 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 offering CSV template export process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

ルート・スキーマ : schema

すべてに一致

Show Source

object setupOfferingCSVTemplateExports-item
object type

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

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

タイプ: object

Show Source

FunctionalAreaCode: string

タイトル: Functional Area Code

設定機能領域の一意のコード。この属性は、機能領域の設定オファリングCSVテンプレートをエクスポートする場合に必要です。
OfferingCode: string

タイトル: Offering Code

設定オファリングの一意のコード。この属性は、オファリングの設定オファリングCSVテンプレートをエクスポートする場合に必要です。

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "FunctionalAreaCode":{
            "title":"Functional Area Code",
            "type":"string",
            "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

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

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

タイプ: array

Show Source

Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

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

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

すべてに一致

Show Source

object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

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

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

タイプ: object

Show Source

OfferingCode: string

タイトル: Offering Code

CSVテンプレートが生成される設定オファリングの一意のコード。
ProcessCompletedFlag: string

タイトル: Process Complete

エクスポート・プロセスが完了したかどうかを示します。この属性にはデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定オファリングCSVテンプレート・エクスポート・プロセスの一意識別子。

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup offering CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering 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 export process is complete. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request"
            }
        }
    }
}

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

タイプ: array

Show Source

Array of: object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request"
    }
}

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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}=)?$

設定オファリング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

エクスポート・プロセスのステータス。有効な値は、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 offering CSV template export process result.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup offering CSV template export process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the 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 offering 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":"The .zip file containing the setup offering 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 offering 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 offering 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 offering or functional area 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 offering 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

デフォルト・レスポンス

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

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

すべてに一致

Show Source

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

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

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

タイプ: object

Show Source

FunctionalAreaCode: string

タイトル: Functional Area Code

設定機能領域の一意のコード。この属性は、機能領域の設定オファリングCSVテンプレートをエクスポートする場合に必要です。
OfferingCode: string

タイトル: Offering Code

設定オファリングの一意のコード。この属性は、オファリングの設定オファリングCSVテンプレートをエクスポートする場合に必要です。

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "FunctionalAreaCode":{
            "title":"Functional Area Code",
            "type":"string",
            "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVTemplateExportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-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."
        }
    }
}

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

タイプ: array

Show Source

Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response

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

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response

すべてに一致

Show Source

object ItemProperties
object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupOfferingCSVTemplateExportProcessResult":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response"
                    }
                }
            }
        }
    ]
}

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

タイプ: object

Show Source

OfferingCode: string

タイトル: Offering Code

CSVテンプレートが生成される設定オファリングの一意のコード。
ProcessCompletedFlag: string

タイトル: Process Complete

エクスポート・プロセスが完了したかどうかを示します。この属性にはデフォルト値がありません。
ProcessId: integer (int32)

タイトル: Process ID

設定オファリングCSVテンプレート・エクスポート・プロセスの一意識別子。

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup offering CSV template export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering 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 export process is complete. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

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

タイプ: object

Show Source

SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVTemplateExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response"
            }
        }
    }
}

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

タイプ: array

Show Source

Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response"
    }
}

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response

すべてに一致

Show Source

object ItemProperties
object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item"
        }
    ]
}

ネストされたスキーマ : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-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}=)?$

設定オファリング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

エクスポート・プロセスのステータス。有効な値は、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 offering CSV template export process result.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup offering CSV template export process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the 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 offering 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":"The .zip file containing the setup offering 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 offering 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 offering 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 offering or functional area 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 offering 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/setupOfferingCSVTemplateExports

リクエスト本文の例

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

{
  "OfferingCode" : "XLE_FINANCIALS_JUR",
  "FunctionalAreaCode" : "ORA_ASK_ORGANIZATION_STRUCTURE",
  "SetupOfferingCSVTemplateExportProcess" : [{  "OfferingCode" : "XLE_FINANCIALS_JUR"}]

}

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

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

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

レスポンス本文の例

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

{
    "OfferingCode": "XLE_FINANCIALS_JUR",
    "FunctionalAreaCode": "ORA_ASK_ORGANIZATION_STRUCTURE",
    "SetupOfferingCSVTemplateExportProcess": [
        {
            "ProcessId": 300100068274827,
            "OfferingCode": "XLE_FINANCIALS_JUR",
            "ProcessCompletedFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827",
                    "name": "SetupOfferingCSVTemplateExportProcess",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827",
                    "name": "SetupOfferingCSVTemplateExportProcess",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR",
                    "name": "setupOfferingCSVTemplateExports",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827/child/SetupOfferingCSVTemplateExportProcessResult",
                    "name": "SetupOfferingCSVTemplateExportProcessResult",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR",
            "name": "setupOfferingCSVTemplateExports",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR",
            "name": "setupOfferingCSVTemplateExports",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess",
            "name": "SetupOfferingCSVTemplateExportProcess",
            "kind": "collection"
        }
    ]
}

「トップに戻る」