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

機械翻訳について

バルク操作

post

/hcmRestApi/scim/Bulk

バルク操作

リクエスト

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

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

ルート・スキーマ : schema

タイプ: object

Show Source

bulkId: string

タイトル: bulkId

新しく作成されたリソースの一時識別子。一括リクエスト内で一意であり、クライアントによって作成されます。
data: string

タイトル: data

単一のPOSTまたはPATCHリソース操作の場合に表示されるリソース・データ。
method: string

タイトル: method

現在の操作のHTTPメソッド。
path: string

タイトル: path

リソースの相対パス。メソッドがPOSTの場合、値はリソース・タイプ・エンドポイント( /Usersなど)を指定する必要があります。その他のすべてのメソッドの場合、値は特定のリソースへのパスを指定する必要があります(例: /Users/2819c223-7f76-453a-919d-413861904646)。

{
    "type":"object",
    "properties":{
        "bulkId":{
            "title":"bulkId",
            "type":"string",
            "description":"The transient identifier of a newly created resource, which is unique within a bulk request and created by the client."
        },
        "method":{
            "title":"method",
            "type":"string",
            "description":"The HTTP method of the current operation."
        },
        "data":{
            "title":"data",
            "type":"string",
            "description":"The resource data as it would appear for a single POST or PATCH resource operation."
        },
        "path":{
            "title":"path",
            "type":"string",
            "description":"The relative path of the resource. If the method is POST, the value must specify a resource type endpoint, for example, /Users. For all the other methods, the value must specify the path to a specific resource, for example, /Users/2819c223-7f76-453a-919d-413861904646."
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルト・レスポンス

次の表に、このタスクのレスポンスを示します。

ルート・スキーマ : バルク

タイプ: object

Show Source

Operations: array Operations

タイトル: Operations

一括ジョブ内で定義された操作。各操作は、リソース・エンドポイントに対する単一のHTTPリクエストに対応します。

{
    "type":"object",
    "properties":{
        "Operations":{
            "title":"Operations",
            "type":"array",
            "description":"The operations defined within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.",
            "items":{
                "$ref":"#/components/schemas/Operation-item"
            }
        }
    }
}

ネストされたスキーマ : 操作

タイプ: array

タイトル: Operations

一括ジョブ内で定義された操作。各操作は、リソース・エンドポイントに対する単一のHTTPリクエストに対応します。

Show Source

Array of: object Operation-item

{
    "title":"Operations",
    "type":"array",
    "description":"The operations defined within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.",
    "items":{
        "$ref":"#/components/schemas/Operation-item"
    }
}

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

タイプ: object

Show Source

bulkId: string

タイトル: bulkId

新しく作成されたリソースの一時識別子。一括リクエスト内で一意であり、クライアントによって作成されます。
location: string

タイトル: location

リソース・エンドポイントURL。
method: string

タイトル: method

現在の操作のHTTPメソッド。
status: object status

タイトル: status

一括ジョブ内の1つの操作の成功または失敗に関する情報を含む複合タイプ。

{
    "type":"object",
    "properties":{
        "location":{
            "title":"location",
            "type":"string",
            "description":"The resource endpoint URL."
        },
        "method":{
            "title":"method",
            "type":"string",
            "description":"The HTTP method of the current operation."
        },
        "bulkId":{
            "title":"bulkId",
            "type":"string",
            "description":"The transient identifier of a newly created resource, which is unique within a bulk request and created by the client."
        },
        "status":{
            "title":"status",
            "type":"object",
            "properties":{
            },
            "description":"A complex type that contains information about the success or failure of one operation within the bulk job."
        }
    }
}

ネストされたスキーマ : ステータス

タイプ: object

タイトル: status

一括ジョブ内の1つの操作の成功または失敗に関する情報を含む複合タイプ。

Show Source

{
    "title":"status",
    "type":"object",
    "properties":{
    },
    "description":"A complex type that contains information about the success or failure of one operation within the bulk job."
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによってリソースを作成する方法を示しています。

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X POST -d <payload>   https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Bulk

リクエスト・ペイロードの例

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

{
 "Operations":[
  {
   "method":"POST",
   "path":"/Users",
   "bulkId":"clientBulkId1",
   "data":{
     "schemas":[
      "urn:scim:schemas:core:2.0:User"
     ],
     "name":{
      "familyName":"Jones",
      "givenName":"Kerry"
     },
     "active":true,
     "userName":"JONESK_OPERATIONS",
     "emails":[
      {
       "primary":true,
       "value":"J.K@oracle.com",
       "type":"W"
      }
     ],
     "displayName":"Kerry Jones",
     "externalId":"externalId12345:"
   }
  },
  {
   "method":"PATCH",
   "path":"/Users/3DEC63ED61FD0863E050F00A081B15FF",
   "bulkId":"clientBulkId1",
   "data":{
     "schemas":[
      "urn:scim:schemas:core:2.0:User"
     ],
     "active":false
   }
  },
  {
   "method":"PUT",
   "path":"/Users/3DEC63ED61FD0863E050F00A081B15FF",
   "bulkId":"clientBulkId1",
   "data": {
     "schemas":[
      "urn:scim:schemas:core:2.0:User"
     ],
     "name":{
      "familyName":"Jones",
      "givenName":"Kerry"
     },
     "active":true,
     "userName":"JONESK_OPERATIONS_UPDATED",
     "emails":[
      {
       "primary":true,
       "value":"J.K@oracle.com",
       "type":"W"
      }
     ],
     "displayName":"Kerry Jones",
     "externalId":"externalId12345_Updated_by_PUT:"
   }
  },
  {
   "method":"DELETE",
   "path":"/Users/3DEC63ED61FD0863E050F00A081B15FF",
   "bulkId":"clientBulkId1"
  },
  {
   "method":"PATCH",
   "path":"/Roles/6FC956208A6A4E87A1F57E76F08D1616",
   "bulkId":"clientBulkId1",
   "data": {
    "members": [
    {
     "value": "FE4222FEF1A63883F49F0B1D93224B8E",
     "operation": "ADD"
    },
    {
     "value": "C2A28F8ED9FA377A20C8E3D614936E88",
     "operation": "REMOVE"
    }]
   }
  }
 ]
}

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

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

Status: HTTP/1.1 200 OK
Content-Type : application/json

レスポンス本文の例

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

{
    "Operations": [
        {
            "location": "http://host:port/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15GG",
            "method": "POST",
            "bulkId": "clientBulkId1",
            "status": {
                "code": "201"
            }
        },
  {
            "location": "http://host:port/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF",
            "method": "PATCH",
            "bulkId": "clientBulkId1",
            "status": {
                "code": "200"
            }
        },
  {
            "location": "http://host:port/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF",
            "method": "PUT",
            "bulkId": "clientBulkId1",
            "status": {
                "code": "200"
            }
        },
  {
            "location": "http://host:port/hcmRestApi/scim/Users/3DEC63ED61FD0863E050F00A081B15FF",
            "method": "DELETE",
            "bulkId": "clientBulkId1",
            "status": {
                "code": "204"
            }
        },
  {
            "location": "http://host:port/hcmRestApi/scim/Roles/6FC956208A6A4E87A1F57E76F08D1616",
            "method": "PATCH",
            "bulkId": "clientBulkId1",
            "status": {
                "code": "204"
            }
        }
    ]
}

「トップに戻る」