de.gold.scim.common.response.bulk-response.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-common Show documentation
The newest version!
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id": "urn:ietf:params:scim:api:messages:2.0:BulkResponse",
  "name": "BulkRequest",
  "description": "schema representation of a bulk response",
  "attributes": [
    {
      "name": "Operations",
      "type": "complex",
      "description": "Defines operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint. REQUIRED.",
      "mutability": "readOnly",
      "returned": "always",
      "uniqueness": "none",
      "multiValued": true,
      "caseExact": false,
      "required": true,
      "subAttributes": [
        {
          "name": "method",
          "type": "string",
          "description": "The HTTP method of the current operation.  Possible values are 'POST', 'PUT', 'PATCH', or 'DELETE'.  REQUIRED.",
          "canonicalValues": [
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ],
          "mutability": "readOnly",
          "returned": "always",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": true
        },
        {
          "name": "bulkId",
          "type": "string",
          "description": "The transient identifier of a newly created resource, unique within a bulk request and created by the client. The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.  REQUIRED when \"method\" is \"POST\".",
          "mutability": "readOnly",
          "returned": "default",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": false
        },
        {
          "name": "version",
          "type": "string",
          "description": "The current resource version. Version MAY be used if the service provider supports entity-tags (ETags) (Section 2.3 of [RFC7232]) and \"method\" is \"PUT\", \"PATCH\", or \"DELETE\".",
          "mutability": "readOnly",
          "returned": "default",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": true,
          "required": false
        },
        {
          "name": "location",
          "type": "string",
          "description": "The resource endpoint URL. REQUIRED in a response, except in the event of a POST failure.",
          "mutability": "readOnly",
          "returned": "default",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": false
        },
        {
          "name": "response",
          "type": "string",
          "description": "The HTTP response body for the specified request operation. When indicating a response with an HTTP status other than a 200-series response, the response body MUST be included. For normal completion, the server MAY elect to omit the response body.",
          "mutability": "readOnly",
          "returned": "default",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": false
        },
        {
          "name": "status",
          "type": "integer",
          "description": "The HTTP response status code for the requested operation. When indicating an error, the \"response\" attribute MUST contain  the detail error response as per Section 3.12.",
          "mutability": "readOnly",
          "returned": "always",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": true
        }
      ]
    }
  ],
  "meta": {
    "resourceType": "Schema",
    "created": "2019-10-18T14:51:11+02:00",
    "lastModified": "2019-10-18T14:51:11+02:00",
    "location": "/Schemas/BulkResponse"
  }
}