{"openapi":"3.0.4","info":{"title":"Batch amend entities Custom Data Model membership.","description":"Add/Remove entities to/from a Custom Data Model in a single operation.\r\n            \r\nEach amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.\r\nIt serves only as a way to easily identify each amendment in the response.\r\n            \r\nNote: If using partial failure modes, then it is important to check the response body for failures as any\r\nfailures will still return a 200 status code.","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/datamodel/$batchamend":{"post":{"tags":["Custom Data Models"],"summary":"Batch amend entities Custom Data Model membership.","description":"Add/Remove entities to/from a Custom Data Model in a single operation.\r\n            \r\nEach amendment request must be keyed by a unique correlation ID.  This id is ephemeral and is not stored by LUSID.\r\nIt serves only as a way to easily identify each amendment in the response.\r\n            \r\nNote: If using partial failure modes, then it is important to check the response body for failures as any\r\nfailures will still return a 200 status code.","operationId":"BatchAmend","parameters":[{"name":"successMode","in":"query","description":"Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.","required":true,"schema":{"maxLength":64,"minLength":1,"type":"string","default":"Partial"}}],"requestBody":{"description":"The payload describing the amendments to make for the given Custom Data Model.","content":{"application/json-patch+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MembershipAmendmentRequest"}},"example":{"ephemeral-id-1":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145","operation":"Add"},"ephemeral-id-2":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"87lr929k-2937-23j3-j293-ds94n726n204","operation":"Remove"},"ephemeral-id-3":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode2"},"entityType":"Instrument","entityUniqueId":"61apo865d-8019-41g7-a692-ad97j480c382","operation":"Add"}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MembershipAmendmentRequest"}},"example":{"ephemeral-id-1":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145","operation":"Add"},"ephemeral-id-2":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"87lr929k-2937-23j3-j293-ds94n726n204","operation":"Remove"},"ephemeral-id-3":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode2"},"entityType":"Instrument","entityUniqueId":"61apo865d-8019-41g7-a692-ad97j480c382","operation":"Add"}}},"text/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MembershipAmendmentRequest"}},"example":{"ephemeral-id-1":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145","operation":"Add"},"ephemeral-id-2":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"87lr929k-2937-23j3-j293-ds94n726n204","operation":"Remove"},"ephemeral-id-3":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode2"},"entityType":"Instrument","entityUniqueId":"61apo865d-8019-41g7-a692-ad97j480c382","operation":"Add"}}},"application/*+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/MembershipAmendmentRequest"}},"example":{"ephemeral-id-1":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145","operation":"Add"},"ephemeral-id-2":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode"},"entityType":"Instrument","entityUniqueId":"87lr929k-2937-23j3-j293-ds94n726n204","operation":"Remove"},"ephemeral-id-3":{"customDataModelId":{"scope":"MyScope","code":"MyCDMCode2"},"entityType":"Instrument","entityUniqueId":"61apo865d-8019-41g7-a692-ad97j480c382","operation":"Add"}}}},"required":true},"responses":{"200":{"description":"The batch amendment operation was successful","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchAmendCustomDataModelMembershipResponse"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchAmendCustomDataModelMembershipResponse"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/BatchAmendCustomDataModelMembershipResponse"}}}},"400":{"description":"The details of the input related failure","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidValidationProblemDetails"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/LusidProblemDetails"}}}}},"security":[{"BearerAuth":[]}],"x-fbn-apistatus":"Experimental"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}