Bulk operation
post
/hcmRestApi/scim/Bulk
Bulk operation
Request
There are no request parameters for this operation.
Supported Media Types
- */*
Root Schema : schema
Type:
Show Source
object
-
bulkId: string
Title:
bulkId
The transient identifier of a newly created resource, which is unique within a bulk request and created by the client. -
data: string
Title:
data
The resource data as it would appear for a single POST or PATCH resource operation. -
method: string
Title:
method
The HTTP method of the current operation. -
path: string
Title:
path
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the response for this task.
Root Schema : Bulk
Type:
Show Source
object
-
Operations: array
Operations
Title:
Operations
The operations defined within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.
Nested Schema : Operations
Type:
array
Title:
Operations
The operations defined within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint.
Show Source
Nested Schema : Operation-item
Type:
Show Source
object
-
bulkId: string
Title:
bulkId
The transient identifier of a newly created resource, which is unique within a bulk request and created by the client. -
location: string
Title:
location
The resource endpoint URL. -
method: string
Title:
method
The HTTP method of the current operation. -
status: object
status
Title:
status
A complex type that contains information about the success or failure of one operation within the bulk job.
Nested Schema : status
Type:
object
Title:
status
A complex type that contains information about the success or failure of one operation within the bulk job.
Show Source
Examples
The following example shows how to create resources by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/hcmRestApi/scim/Bulk
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "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" }] } } ] }
Example of Response Header
The following shows an example of the response header.
Status: HTTP/1.1 200 OK Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "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" } } ] }