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

機械翻訳について

設定タスクのCSVエクスポートの取得

get

/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/{TaskCode}

リクエスト

パス・パラメータ

TaskCode(required): string

設定タスクの短縮コード。この属性は必須です。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされる属性である依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定された属性は、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されている場合、属性はリソース・コレクション・ペイロードを生成する前に親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性属性のセットです。例: dependency=ProductId=2

フォーマット: <attr1> = <val1>, <attr2> = <value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。セパレータとしてカンマを使用して複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、書式" Child.NestedChild " (例)に従って指定することもできます: ?expand= Employees.Managers ). ネストされた子が指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees, Employees.Managers" (従業員とマネージャを展開する)と同じです。
fields: string

このパラメータは、リソース属性をフィルタします。指定された属性のみが返されます。つまり、属性が指定されていない場合、属性は返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。たとえば、"?fields= Employees.Managers:Empname"は"?fields=;Employees:; Employees.Managers:Empname"と同じです(これはマネージャの"Empname"フィールドのみを返します)。この問合せパラメータの値は、リソース属性のリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers ) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
onlyData: boolean

データのみを含めるために(リンク・セクションなしなど)、リソース・アイテム・ペイロードがフィルタ処理されます。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

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

デフォルト・レスポンス

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

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

すべてに一致

Show Source

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

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

ネストされたスキーマ : 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"
            }
        }
    }
}

ネストされたスキーマ : setupTaskCSVExports-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 file is generated.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ExportSupportedFlag":{
            "title":"Export to CSV Support",
            "type":"string",
            "description":"Indicates whether CSV export is supported for the setup task.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

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

タイプ: object

Show Source

SetupTaskCSVExportCriteria: array SetupTaskCSVExportCriteria
SetupTaskCSVExportProcess: array SetupTaskCSVExportProcess

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

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

タイプ: 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."
        }
    }
}

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

タイプ: array

Show Source

Array of: setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response

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

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

タイプ: array

Show Source

Array of: setupTaskCSVExports-SetupTaskCSVExportProcess-item-response

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

ネストされたスキーマ : setupTaskCSVExports-SetupTaskCSVExportCriteria-item-response

すべてに一致

Show Source

object ItemProperties
object schema

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

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

タイプ: object

Show Source

AttributeName: string

タイトル: Attribute Name

ビジネス・オブジェクトのフィルタ基準を定義する属性の名前。
AttributeSet: string

タイトル: Attribute Set

属性-値ペアのグループを識別し、単一のフィルタ条件を形成する属性セットの名前。
AttributeValue: string

タイトル: Attribute Value

ビジネス・オブジェクトのフィルタ基準を定義する属性に適用可能な値。
BusinessObjectCode: string

タイトル: Business Object Code

フィルタ条件の定義に使用されるビジネス・オブジェクトの一意のコード。
ProcessId: integer (int32)

タイトル: Process ID

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

タイトル: Task Code

CSVファイルが生成される設定タスクの一意のコード。

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

ネストされたスキーマ : setupTaskCSVExports-SetupTaskCSVExportProcess-item-response

すべてに一致

Show Source

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

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

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

タイプ: object

Show Source

ProcessCompletedFlag: string

タイトル: Process Complete

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

タイトル: Process ID

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

タイトル: Task Code

CSVファイルが生成される設定タスクの一意のコード。

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

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

タイプ: object

Show Source

SetupTaskCSVExportProcessResult: array SetupTaskCSVExportProcessResult

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

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

タイプ: array

Show Source

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

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

ネストされたスキーマ : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item-response

すべてに一致

Show Source

object ItemProperties
object setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-item

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

ネストされたスキーマ : setupTaskCSVExports-SetupTaskCSVExportProcess-SetupTaskCSVExportProcessResult-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

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

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、設定タスクのCSVエクスポートを取得する方法を示しています。

curl -i -u "<username>:<password>" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/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": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES",
            "name": "setupTaskCSVExports",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES",
            "name": "setupTaskCSVExports",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportProcess",
            "name": "SetupTaskCSVExportProcess",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVExports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVExportCriteria",
            "name": "SetupTaskCSVExportCriteria",
            "kind": "collection"
        }
    ]
}

「トップに戻る」