{"openapi":"3.0.4","info":{"title":"Upsert Instrument Event Instructions","description":"Batch upsert for instrument event instructions, for the portfolio or individual holdings","version":"0.0.1"},"servers":[{"url":"https://fbn-prd.lusid.com/api"}],"paths":{"/api/portfolios/{scope}/{code}/instrumenteventinstructions":{"post":{"tags":["Portfolios"],"summary":"Upsert Instrument Event Instructions","description":"Batch upsert for instrument event instructions, for the portfolio or individual holdings","operationId":"UpsertInstrumentEventInstructions","parameters":[{"name":"scope","in":"path","description":"The scope of the portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"code","in":"path","description":"The code of the portfolio. Together with the scope this uniquely identifies the portfolio.","required":true,"schema":{"maxLength":64,"minLength":1,"pattern":"^[a-zA-Z0-9\\-_]+$","type":"string"}},{"name":"portfolioEffectiveAt","in":"query","description":"The effective date at which the portfolio will be resolved. Defaults to current time if not specified.","schema":{"maxLength":6000,"minLength":0,"type":"string","format":"dateorcutlabel"}},{"name":"successMode","in":"query","description":"Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)","required":true,"schema":{"maxLength":64,"minLength":1,"type":"string","default":"Partial"}}],"requestBody":{"description":"The instructions to be upserted to the portfolio.","content":{"application/json-patch+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionRequest"}},"example":{"request":{"instrumentEventInstructionId":"ExampleInstructionId","instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}}},"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionRequest"}},"example":{"request":{"instrumentEventInstructionId":"ExampleInstructionId","instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}}},"text/json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionRequest"}},"example":{"request":{"instrumentEventInstructionId":"ExampleInstructionId","instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}}},"application/*+json":{"schema":{"type":"object","additionalProperties":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionRequest"}},"example":{"request":{"instrumentEventInstructionId":"ExampleInstructionId","instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}}}},"required":true},"responses":{"200":{"description":"The newly inserted or updated instrument event instructions","content":{"application/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionsResponse"},"example":{"values":{"success":{"instrumentEventInstructionId":"ExampleInstructionId","portfolioId":{"scope":"ExampleScope","code":"ExampleCode"},"instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"version":{"effectiveFrom":"2020-01-01T12:00:00.0000000+00:00","asAtDate":"2020-01-01T12:00:00.0000000+00:00","asAtCreated":"2020-01-01T12:00:00.0000000+00:00","userIdCreated":"UserId","requestIdCreated":"RequestId","reasonCreated":"","asAtModified":"2020-01-01T12:00:00.0000000+00:00","userIdModified":"UserId","requestIdModified":"RequestId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145"},"href":"http://www.example.com/","entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}},"failed":{"failure":{"detail":"Example Failure"}}}},"text/plain":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionsResponse"},"example":{"values":{"success":{"instrumentEventInstructionId":"ExampleInstructionId","portfolioId":{"scope":"ExampleScope","code":"ExampleCode"},"instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"version":{"effectiveFrom":"2020-01-01T12:00:00.0000000+00:00","asAtDate":"2020-01-01T12:00:00.0000000+00:00","asAtCreated":"2020-01-01T12:00:00.0000000+00:00","userIdCreated":"UserId","requestIdCreated":"RequestId","reasonCreated":"","asAtModified":"2020-01-01T12:00:00.0000000+00:00","userIdModified":"UserId","requestIdModified":"RequestId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145"},"href":"http://www.example.com/","entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}},"failed":{"failure":{"detail":"Example Failure"}}}},"text/json":{"schema":{"$ref":"/docs/api/lusid/schemas.json#/components/schemas/InstrumentEventInstructionsResponse"},"example":{"values":{"success":{"instrumentEventInstructionId":"ExampleInstructionId","portfolioId":{"scope":"ExampleScope","code":"ExampleCode"},"instrumentEventId":"ExampleInstrumentEventId","instructionType":"ElectForHolding","electionKey":"GBP","holdingId":123456789,"version":{"effectiveFrom":"2020-01-01T12:00:00.0000000+00:00","asAtDate":"2020-01-01T12:00:00.0000000+00:00","asAtCreated":"2020-01-01T12:00:00.0000000+00:00","userIdCreated":"UserId","requestIdCreated":"RequestId","reasonCreated":"","asAtModified":"2020-01-01T12:00:00.0000000+00:00","userIdModified":"UserId","requestIdModified":"RequestId","reasonModified":"","asAtVersionNumber":1,"entityUniqueId":"41ad555a-7585-41b7-a057-af27c760e145"},"href":"http://www.example.com/","entitlementDateInstructed":"2020-01-01T12:00:00.0000000+00:00","ignoreCostImpact":false}},"failed":{"failure":{"detail":"Example Failure"}}}}}},"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":"EarlyAccess"}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}