Webex · Example Payload

Webex User Bulk Api Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex User Bulk Api Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "User bulk API",
  "method": "POST",
  "path": "/identity/scim/{orgId}/v2/Bulk",
  "summary": "User bulk API",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "schemas": [
          "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
        ],
        "failOnErrors": 99,
        "operations": [
          {
            "method": "PATCH",
            "path": "/Users/2819c223-7f76-453a-919d-413861904646",
            "data": "JSON text",
            "bulkId": "ytrewq"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "schemas": [
          "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
        ],
        "Operations": [
          {
            "location": "https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a",
            "method": "POST",
            "bulkId": "qwerty",
            "version": "W/\"oY4m4wn58tkVjJxK\"",
            "status": "201"
          },
          {
            "location": "https://example.com/v2/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc",
            "method": "PATCH",
            "version": "W/\"huJj29dMNgu3WXPD\"",
            "status": "200"
          },
          {
            "location": "https://example.com/v2/Users/e9025315-6bea-44e1-899c-1e07454e468b",
            "method": "DELETE",
            "status": "204"
          }
        ]
      }
    }
  ]
}