All URIs are relative to https://www.lusid.com/api
| Method | HTTP request | Description |
|---|---|---|
| deletePerson | DELETE /api/persons/{idTypeScope}/{idTypeCode}/{code} | DeletePerson: Delete person |
| deletePersonAccessMetadata | DELETE /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry |
| deletePersonIdentifiers | DELETE /api/persons/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers |
| deletePersonProperties | DELETE /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties | [EARLY ACCESS] DeletePersonProperties: Delete Person Properties |
| getAllPersonAccessMetadata | GET /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata | [EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person |
| getPerson | GET /api/persons/{idTypeScope}/{idTypeCode}/{code} | [EARLY ACCESS] GetPerson: Get Person |
| getPersonAccessMetadataByKey | GET /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person |
| getPersonPropertyTimeSeries | GET /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties/time-series | [EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series |
| getPersonRelations | GET /api/persons/{idTypeScope}/{idTypeCode}/{code}/relations | [EARLY ACCESS] GetPersonRelations: Get Relations for Person |
| getPersonRelationships | GET /api/persons/{idTypeScope}/{idTypeCode}/{code}/relationships | [EARLY ACCESS] GetPersonRelationships: Get Relationships for Person |
| listAllPersons | GET /api/persons | [EARLY ACCESS] ListAllPersons: List All Persons |
| listPersons | GET /api/persons/{idTypeScope}/{idTypeCode} | [EARLY ACCESS] ListPersons: List Persons |
| patchPersonAccessMetadata | PATCH /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata | [EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person. |
| setPersonIdentifiers | POST /api/persons/{idTypeScope}/{idTypeCode}/{code}/identifiers | [EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers |
| setPersonProperties | POST /api/persons/{idTypeScope}/{idTypeCode}/{code}/properties | [EARLY ACCESS] SetPersonProperties: Set Person Properties |
| upsertPerson | POST /api/persons | UpsertPerson: Upsert Person |
| upsertPersonAccessMetadata | PUT /api/persons/{idTypeScope}/{idTypeCode}/{code}/metadata/{metadataKey} | [EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. |
| upsertPersons | POST /api/persons/$batchUpsert | [EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons |
DeletedEntityResponse deletePerson(idTypeScope, idTypeCode, code)
DeletePerson: Delete person
Delete a person. Deletion will be valid from the person's creation datetime. This means that the person will no longer exist at any effective datetime from the asAt datetime of deletion.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | The scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | The code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete.
try {
// uncomment the below to set overrides at the request level
// DeletedEntityResponse result = apiInstance.deletePerson(idTypeScope, idTypeCode, code).execute(opts);
DeletedEntityResponse result = apiInstance.deletePerson(idTypeScope, idTypeCode, code).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#deletePerson");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | The scope of the person identifier type. | |
| idTypeCode | String | The code of the person identifier type. | |
| code | String | Code of the person under specified identifier type scope and code. This together with defined identifier type uniquely identifies the person to delete. |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The response from deleting person. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
DeletedEntityResponse deletePersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, effectiveUntil)
[EARLY ACCESS] DeletePersonAccessMetadata: Delete a Person Access Metadata entry
Deletes the Person Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code.
String metadataKey = "metadataKey_example"; // String | Key of the metadata entry to retrieve
String effectiveAt = "effectiveAt_example"; // String | The effective date to delete at, if this is not supplied, it will delete all data found
OffsetDateTime effectiveUntil = OffsetDateTime.now(); // OffsetDateTime | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata
try {
// uncomment the below to set overrides at the request level
// DeletedEntityResponse result = apiInstance.deletePersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, effectiveUntil).execute(opts);
DeletedEntityResponse result = apiInstance.deletePersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, effectiveUntil).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#deletePersonAccessMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier. | |
| idTypeCode | String | Code of the person identifier. | |
| code | String | Code of the person under specified identifier type's scope and code. | |
| metadataKey | String | Key of the metadata entry to retrieve | |
| effectiveAt | String | The effective date to delete at, if this is not supplied, it will delete all data found | [optional] |
| effectiveUntil | OffsetDateTime | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The Access Metadata with the given metadataKey has been deleted | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
DeletedEntityResponse deletePersonIdentifiers(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt)
[EARLY ACCESS] DeletePersonIdentifiers: Delete Person Identifiers
Delete identifiers that belong to the given property keys of the person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
List<String> propertyKeys = Arrays.asList(); // List<String> | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Identifiers or identifiers not specified in request will not be changed.
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual.
try {
// uncomment the below to set overrides at the request level
// DeletedEntityResponse result = apiInstance.deletePersonIdentifiers(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt).execute(opts);
DeletedEntityResponse result = apiInstance.deletePersonIdentifiers(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#deletePersonIdentifiers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| propertyKeys | List<String> | The property keys of the identifiers to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Identifiers or identifiers not specified in request will not be changed. | |
| effectiveAt | String | The effective datetime or cut label at which to delete the identifiers. Defaults to the current LUSID system datetime if not specified. Must not include an effective datetime if identifiers are perpetual. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The datetime that the identifiers were deleted from the specified person | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
DeletedEntityResponse deletePersonProperties(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt)
[EARLY ACCESS] DeletePersonProperties: Delete Person Properties
Delete all properties that belong to the given property keys of the person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
List<String> propertyKeys = Arrays.asList(); // List<String> | The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain. Properties or identifiers not specified in request will not be changed.
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual.
try {
// uncomment the below to set overrides at the request level
// DeletedEntityResponse result = apiInstance.deletePersonProperties(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt).execute(opts);
DeletedEntityResponse result = apiInstance.deletePersonProperties(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#deletePersonProperties");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| propertyKeys | List<String> | The property keys of the person's properties to delete. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. Properties or identifiers not specified in request will not be changed. | |
| effectiveAt | String | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The datetime that the properties were deleted from the specified person | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Map<String, List<AccessMetadataValue>> getAllPersonAccessMetadata(idTypeScope, idTypeCode, code, effectiveAt, asAt)
[EARLY ACCESS] GetAllPersonAccessMetadata: Get Access Metadata rules for a Person
Pass the Scope and Code of the Person identifier along with the person code parameter to retrieve the associated Access Metadata
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code.
String effectiveAt = "effectiveAt_example"; // String | The effectiveAt datetime at which to retrieve the Access Metadata
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the Access Metadata
try {
// uncomment the below to set overrides at the request level
// Map<String, List<AccessMetadataValue>> result = apiInstance.getAllPersonAccessMetadata(idTypeScope, idTypeCode, code, effectiveAt, asAt).execute(opts);
Map<String, List<AccessMetadataValue>> result = apiInstance.getAllPersonAccessMetadata(idTypeScope, idTypeCode, code, effectiveAt, asAt).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getAllPersonAccessMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier. | |
| idTypeCode | String | Code of the person identifier. | |
| code | String | Code of the person under specified identifier type's scope and code. | |
| effectiveAt | String | The effectiveAt datetime at which to retrieve the Access Metadata | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to retrieve the Access Metadata | [optional] |
Map<String, List<AccessMetadataValue>>
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The access metadata for the Person or any failure. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Person getPerson(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt, asAt, relationshipDefinitionIds)
[EARLY ACCESS] GetPerson: Get Person
Retrieve the definition of a person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person.
List<String> propertyKeys = Arrays.asList(); // List<String> | A list of property keys from the \"Person\" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified.
List<String> relationshipDefinitionIds = Arrays.asList(); // List<String> | A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
try {
// uncomment the below to set overrides at the request level
// Person result = apiInstance.getPerson(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt, asAt, relationshipDefinitionIds).execute(opts);
Person result = apiInstance.getPerson(idTypeScope, idTypeCode, code, propertyKeys, effectiveAt, asAt, relationshipDefinitionIds).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getPerson");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified scope and code. This together with stated identifier type uniquely identifies the person. | |
| propertyKeys | List<String> | A list of property keys from the "Person" domain to decorate onto the person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. "Person/ContactDetails/Address". | [optional] |
| effectiveAt | String | The effective datetime or cut label at which to retrieve the person. Defaults to the current LUSID system datetime if not specified. | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to retrieve the person. Defaults to return the latest version of the person if not specified. | [optional] |
| relationshipDefinitionIds | List<String> | A list of relationship definitions that are used to decorate related entities onto the person in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The requested person definition | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
List<AccessMetadataValue> getPersonAccessMetadataByKey(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, asAt)
[EARLY ACCESS] GetPersonAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Person
Get a specific Person Access Metadata by specifying the corresponding identifier parts and Person code No matching will be performed through this endpoint. To retrieve an entry, it is necessary to specify, exactly, the identifier of the entry
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code.
String metadataKey = "metadataKey_example"; // String | Key of the metadata entry to retrieve
String effectiveAt = "effectiveAt_example"; // String | The effectiveAt datetime at which to retrieve the Access Metadata
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the Access Metadata
try {
// uncomment the below to set overrides at the request level
// List<AccessMetadataValue> result = apiInstance.getPersonAccessMetadataByKey(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, asAt).execute(opts);
List<AccessMetadataValue> result = apiInstance.getPersonAccessMetadataByKey(idTypeScope, idTypeCode, code, metadataKey, effectiveAt, asAt).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getPersonAccessMetadataByKey");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier. | |
| idTypeCode | String | Code of the person identifier. | |
| code | String | Code of the person under specified identifier type's scope and code. | |
| metadataKey | String | Key of the metadata entry to retrieve | |
| effectiveAt | String | The effectiveAt datetime at which to retrieve the Access Metadata | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to retrieve the Access Metadata | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The successfully retrieved Person access metadata filtered by metadataKey or any failure. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
ResourceListOfPropertyInterval getPersonPropertyTimeSeries(idTypeScope, idTypeCode, code, propertyKey, asAt, filter, page, limit)
[EARLY ACCESS] GetPersonPropertyTimeSeries: Get Person Property Time Series
List the complete time series of a person property.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
String propertyKey = "propertyKey_example"; // String | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". Each property must be from the \"Person\" domain.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied.
String filter = "filter_example"; // String | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
String page = "page_example"; // String | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
Integer limit = 56; // Integer | When paginating, limit the number of returned results to this many.
try {
// uncomment the below to set overrides at the request level
// ResourceListOfPropertyInterval result = apiInstance.getPersonPropertyTimeSeries(idTypeScope, idTypeCode, code, propertyKey, asAt, filter, page, limit).execute(opts);
ResourceListOfPropertyInterval result = apiInstance.getPersonPropertyTimeSeries(idTypeScope, idTypeCode, code, propertyKey, asAt, filter, page, limit).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getPersonPropertyTimeSeries");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| propertyKey | String | The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". Each property must be from the "Person" domain. | |
| asAt | OffsetDateTime | The asAt datetime at which to list the person's property history. Defaults to return the current datetime if not supplied. | [optional] |
| filter | String | Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. | [optional] |
| page | String | The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request. | [optional] |
| limit | Integer | When paginating, limit the number of returned results to this many. | [optional] |
ResourceListOfPropertyInterval
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The time series of the property | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
ResourceListOfRelation getPersonRelations(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes)
[EARLY ACCESS] GetPersonRelations: Get Relations for Person
Get relations for the specified person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified.
String filter = "filter_example"; // String | Expression to filter the relations. Users should provide null or empty string for this field until further notice.
List<String> identifierTypes = Arrays.asList(); // List<String> | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. \"Person/CompanyDetails/Role\". They must be from the \"Person\" or \"LegalEntity\" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array.
try {
// uncomment the below to set overrides at the request level
// ResourceListOfRelation result = apiInstance.getPersonRelations(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes).execute(opts);
ResourceListOfRelation result = apiInstance.getPersonRelations(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getPersonRelations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| effectiveAt | String | The effective datetime or cut label at which to get relations. Defaults to the current LUSID system datetime if not specified. | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to retrieve the person's relations. Defaults to return the latest LUSID AsAt time if not specified. | [optional] |
| filter | String | Expression to filter the relations. Users should provide null or empty string for this field until further notice. | [optional] |
| identifierTypes | List<String> | Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The relations for the specified person. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
ResourceListOfRelationship getPersonRelationships(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes)
[EARLY ACCESS] GetPersonRelationships: Get Relationships for Person
Get relationships for the specified person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person's identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person's identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.
String filter = "filter_example"; // String | Expression to filter relationships. Users should provide null or empty string for this field until further notice.
List<String> identifierTypes = Arrays.asList(); // List<String> | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities.
try {
// uncomment the below to set overrides at the request level
// ResourceListOfRelationship result = apiInstance.getPersonRelationships(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes).execute(opts);
ResourceListOfRelationship result = apiInstance.getPersonRelationships(idTypeScope, idTypeCode, code, effectiveAt, asAt, filter, identifierTypes).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#getPersonRelationships");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person's identifier type. | |
| idTypeCode | String | Code of the person's identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| effectiveAt | String | The effective datetime or cut label at which to get relationships. Defaults to the current LUSID system datetime if not specified. | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. | [optional] |
| filter | String | Expression to filter relationships. Users should provide null or empty string for this field until further notice. | [optional] |
| identifierTypes | List<String> | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The relationships for the specified person. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
ResourceListOfPerson listAllPersons(effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds)
[EARLY ACCESS] ListAllPersons: List All Persons
List all persons which the user is entitled to see.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
String page = "page_example"; // String | The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.
Integer limit = 56; // Integer | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified.
String filter = "filter_example"; // String | Expression to filter the result set. For example, to filter on the display name, use \"displayName eq 'John'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
List<String> propertyKeys = Arrays.asList(); // List<String> | A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
List<String> relationshipDefinitionIds = Arrays.asList(); // List<String> | A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
try {
// uncomment the below to set overrides at the request level
// ResourceListOfPerson result = apiInstance.listAllPersons(effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds).execute(opts);
ResourceListOfPerson result = apiInstance.listAllPersons(effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#listAllPersons");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| effectiveAt | String | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. | [optional] |
| page | String | The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. | [optional] |
| limit | Integer | When paginating, limit the number of returned results to this many. Defaults to 5000 if not specified. | [optional] |
| filter | String | Expression to filter the result set. For example, to filter on the display name, use "displayName eq 'John'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. | [optional] |
| propertyKeys | List<String> | A list of property keys from the "Person" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. "Person/ContactDetails/Address". | [optional] |
| relationshipDefinitionIds | List<String> | A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Existing people | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
PagedResourceListOfPerson listPersons(idTypeScope, idTypeCode, effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds)
[EARLY ACCESS] ListPersons: List Persons
List persons which have identifiers of a specific identifier type's scope and code, and satisfies filter criteria.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String effectiveAt = "effectiveAt_example"; // String | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified.
OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified.
String page = "page_example"; // String | The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request.
Integer limit = 56; // Integer | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.
String filter = "filter_example"; // String | Expression to filter the result set. For example, to filter on the LUPID, use \"lusidPersonId eq 'string'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
List<String> propertyKeys = Arrays.asList(); // List<String> | A list of property keys from the \"Person\" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. \"Person/ContactDetails/Address\".
List<String> relationshipDefinitionIds = Arrays.asList(); // List<String> | A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}.
try {
// uncomment the below to set overrides at the request level
// PagedResourceListOfPerson result = apiInstance.listPersons(idTypeScope, idTypeCode, effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds).execute(opts);
PagedResourceListOfPerson result = apiInstance.listPersons(idTypeScope, idTypeCode, effectiveAt, asAt, page, limit, filter, propertyKeys, relationshipDefinitionIds).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#listPersons");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| effectiveAt | String | The effective datetime or cut label at which to list the people. Defaults to the current LUSID system datetime if not specified. | [optional] |
| asAt | OffsetDateTime | The asAt datetime at which to list the people. Defaults to return the latest version of each people if not specified. | [optional] |
| page | String | The pagination token to use to continue listing persons from a previous call to list persons. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt and asAt fields must not have changed since the original request. | [optional] |
| limit | Integer | When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. | [optional] |
| filter | String | Expression to filter the result set. For example, to filter on the LUPID, use "lusidPersonId eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. | [optional] |
| propertyKeys | List<String> | A list of property keys from the "Person" domain to decorate onto each person, or from any domain that supports relationships to decorate onto related entities. These take the format {domain}/{scope}/{code} e.g. "Person/ContactDetails/Address". | [optional] |
| relationshipDefinitionIds | List<String> | A list of relationship definitions that are used to decorate related entities onto the persons in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. | [optional] |
- Content-Type: Not defined
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | People in specified scope | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Map<String, List<AccessMetadataValue>> patchPersonAccessMetadata(idTypeScope, idTypeCode, code, accessMetadataOperation, effectiveAt, effectiveUntil)
[EARLY ACCESS] PatchPersonAccessMetadata: Patch Access Metadata rules for a Person.
Patch Person Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Person Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code.
List<AccessMetadataOperation> accessMetadataOperation = Arrays.asList(); // List<AccessMetadataOperation> | The Json Patch document
String effectiveAt = "effectiveAt_example"; // String | The effectiveAt datetime at which to upsert the Access Metadata
OffsetDateTime effectiveUntil = OffsetDateTime.now(); // OffsetDateTime | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata
try {
// uncomment the below to set overrides at the request level
// Map<String, List<AccessMetadataValue>> result = apiInstance.patchPersonAccessMetadata(idTypeScope, idTypeCode, code, accessMetadataOperation, effectiveAt, effectiveUntil).execute(opts);
Map<String, List<AccessMetadataValue>> result = apiInstance.patchPersonAccessMetadata(idTypeScope, idTypeCode, code, accessMetadataOperation, effectiveAt, effectiveUntil).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#patchPersonAccessMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier. | |
| idTypeCode | String | Code of the person identifier. | |
| code | String | Code of the person under specified identifier type's scope and code. | |
| accessMetadataOperation | List<AccessMetadataOperation> | The Json Patch document | |
| effectiveAt | String | The effectiveAt datetime at which to upsert the Access Metadata | [optional] |
| effectiveUntil | OffsetDateTime | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata | [optional] |
Map<String, List<AccessMetadataValue>>
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The successfully patched items. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Person setPersonIdentifiers(idTypeScope, idTypeCode, code, setPersonIdentifiersRequest)
[EARLY ACCESS] SetPersonIdentifiers: Set Person Identifiers
Set identifiers of the person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
SetPersonIdentifiersRequest setPersonIdentifiersRequest = new SetPersonIdentifiersRequest(); // SetPersonIdentifiersRequest | Request containing identifiers to set for the person. Identifiers not specified in request will not be changed.
try {
// uncomment the below to set overrides at the request level
// Person result = apiInstance.setPersonIdentifiers(idTypeScope, idTypeCode, code, setPersonIdentifiersRequest).execute(opts);
Person result = apiInstance.setPersonIdentifiers(idTypeScope, idTypeCode, code, setPersonIdentifiersRequest).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#setPersonIdentifiers");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| setPersonIdentifiersRequest | SetPersonIdentifiersRequest | Request containing identifiers to set for the person. Identifiers not specified in request will not be changed. |
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The Person with updated identifiers. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Person setPersonProperties(idTypeScope, idTypeCode, code, setPersonPropertiesRequest)
[EARLY ACCESS] SetPersonProperties: Set Person Properties
Set properties of the person.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier type.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier type.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person.
SetPersonPropertiesRequest setPersonPropertiesRequest = new SetPersonPropertiesRequest(); // SetPersonPropertiesRequest | Request containing properties to set for the person. Properties not specified in request will not be changed.
try {
// uncomment the below to set overrides at the request level
// Person result = apiInstance.setPersonProperties(idTypeScope, idTypeCode, code, setPersonPropertiesRequest).execute(opts);
Person result = apiInstance.setPersonProperties(idTypeScope, idTypeCode, code, setPersonPropertiesRequest).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#setPersonProperties");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier type. | |
| idTypeCode | String | Code of the person identifier type. | |
| code | String | Code of the person under specified identifier type's scope and code. This together with stated identifier type uniquely identifies the person. | |
| setPersonPropertiesRequest | SetPersonPropertiesRequest | Request containing properties to set for the person. Properties not specified in request will not be changed. |
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The Person with updated properties or identifiers. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
Person upsertPerson(upsertPersonRequest)
UpsertPerson: Upsert Person
Create or update a new person under the specified scope.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
UpsertPersonRequest upsertPersonRequest = new UpsertPersonRequest(); // UpsertPersonRequest | Request to create or update a person.
try {
// uncomment the below to set overrides at the request level
// Person result = apiInstance.upsertPerson(upsertPersonRequest).execute(opts);
Person result = apiInstance.upsertPerson(upsertPersonRequest).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#upsertPerson");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| upsertPersonRequest | UpsertPersonRequest | Request to create or update a person. |
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The newly created or updated person | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
ResourceListOfAccessMetadataValueOf upsertPersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, upsertPersonAccessMetadataRequest, effectiveAt, effectiveUntil)
[EARLY ACCESS] UpsertPersonAccessMetadata: Upsert a Person Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID.
Update or insert one Person Access Metadata entry in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Person Access Metadata rule or failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String idTypeScope = "idTypeScope_example"; // String | Scope of the person identifier.
String idTypeCode = "idTypeCode_example"; // String | Code of the person identifier.
String code = "code_example"; // String | Code of the person under specified identifier type's scope and code.
String metadataKey = "metadataKey_example"; // String | Key of the metadata entry to retrieve
UpsertPersonAccessMetadataRequest upsertPersonAccessMetadataRequest = new UpsertPersonAccessMetadataRequest(); // UpsertPersonAccessMetadataRequest | The Person Access Metadata entry to upsert
String effectiveAt = "effectiveAt_example"; // String | The effectiveAt datetime at which to upsert the Access Metadata
OffsetDateTime effectiveUntil = OffsetDateTime.now(); // OffsetDateTime | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata
try {
// uncomment the below to set overrides at the request level
// ResourceListOfAccessMetadataValueOf result = apiInstance.upsertPersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, upsertPersonAccessMetadataRequest, effectiveAt, effectiveUntil).execute(opts);
ResourceListOfAccessMetadataValueOf result = apiInstance.upsertPersonAccessMetadata(idTypeScope, idTypeCode, code, metadataKey, upsertPersonAccessMetadataRequest, effectiveAt, effectiveUntil).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#upsertPersonAccessMetadata");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| idTypeScope | String | Scope of the person identifier. | |
| idTypeCode | String | Code of the person identifier. | |
| code | String | Code of the person under specified identifier type's scope and code. | |
| metadataKey | String | Key of the metadata entry to retrieve | |
| upsertPersonAccessMetadataRequest | UpsertPersonAccessMetadataRequest | The Person Access Metadata entry to upsert | |
| effectiveAt | String | The effectiveAt datetime at which to upsert the Access Metadata | [optional] |
| effectiveUntil | OffsetDateTime | The effective datetime until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' datetime of the Access Metadata | [optional] |
ResourceListOfAccessMetadataValueOf
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | The successfully updated or inserted item or any failure. | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README
UpsertPersonsResponse upsertPersons(successMode, requestBody)
[EARLY ACCESS] UpsertPersons: Pluralised Upsert of Persons
Create or updates a collection of person(s).
import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.PersonsApi;
import com.finbourne.lusid.extensions.ApiConfigurationException;
import com.finbourne.lusid.extensions.ApiFactoryBuilder;
import com.finbourne.lusid.extensions.auth.FinbourneTokenException;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
public class PersonsApiExample {
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException, ApiConfigurationException, FinbourneTokenException {
String fileName = "secrets.json";
try(PrintWriter writer = new PrintWriter(fileName, "UTF-8")) {
writer.write("{" +
"\"api\": {" +
" \"tokenUrl\": \"<your-token-url>\"," +
" \"lusidUrl\": \"https://<your-domain>.lusid.com/api\"," +
" \"username\": \"<your-username>\"," +
" \"password\": \"<your-password>\"," +
" \"clientId\": \"<your-client-id>\"," +
" \"clientSecret\": \"<your-client-secret>\"" +
" }" +
"}");
}
// uncomment the below to use configuration overrides
// ConfigurationOptions opts = new ConfigurationOptions();
// opts.setTotalTimeoutMs(2000);
// uncomment the below to use an api factory with overrides
// ApiFactory apiFactory = ApiFactoryBuilder.build(fileName, opts);
// PersonsApi apiInstance = apiFactory.build(PersonsApi.class);
PersonsApi apiInstance = ApiFactoryBuilder.build(fileName).build(PersonsApi.class);
String successMode = "successMode_example"; // String | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial
Map<String, UpsertPersonRequest> requestBody = new HashMap(); // Map<String, UpsertPersonRequest> | A collection of requests to create or update Person(s).
try {
// uncomment the below to set overrides at the request level
// UpsertPersonsResponse result = apiInstance.upsertPersons(successMode, requestBody).execute(opts);
UpsertPersonsResponse result = apiInstance.upsertPersons(successMode, requestBody).execute();
System.out.println(result.toJson());
} catch (ApiException e) {
System.err.println("Exception when calling PersonsApi#upsertPersons");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| successMode | String | Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial | |
| requestBody | Map<String, UpsertPersonRequest> | A collection of requests to create or update Person(s). |
- Content-Type: application/json-patch+json, application/json, text/json, application/*+json
- Accept: text/plain, application/json, text/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | The newly created or updated person(s) | - |
| 400 | The details of the input related failure | - |
| 0 | Error response | - |
Back to top • Back to API list • Back to Model list • Back to README