Skip to content

Latest commit

 

History

History
486 lines (362 loc) · 23.8 KB

RelationshipDefinitionsApi.md

File metadata and controls

486 lines (362 loc) · 23.8 KB

RelationshipDefinitionsApi

All URIs are relative to https://www.lusid.com/api

Method HTTP request Description
createRelationshipDefinition POST /api/relationshipdefinitions [EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition
deleteRelationshipDefinition DELETE /api/relationshipdefinitions/{scope}/{code} [EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition
getRelationshipDefinition GET /api/relationshipdefinitions/{scope}/{code} [EARLY ACCESS] GetRelationshipDefinition: Get relationship definition
listRelationshipDefinitions GET /api/relationshipdefinitions [EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions
updateRelationshipDefinition PUT /api/relationshipdefinitions/{scope}/{code} [EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition

createRelationshipDefinition

RelationshipDefinition createRelationshipDefinition(createRelationshipDefinitionRequest)

[EARLY ACCESS] CreateRelationshipDefinition: Create Relationship Definition

Create a new relationship definition to be used for creating relationships between entities.

Example

import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.RelationshipDefinitionsApi;
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 RelationshipDefinitionsApiExample {

    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);
        // RelationshipDefinitionsApi apiInstance = apiFactory.build(RelationshipDefinitionsApi.class);

        RelationshipDefinitionsApi apiInstance = ApiFactoryBuilder.build(fileName).build(RelationshipDefinitionsApi.class);
        CreateRelationshipDefinitionRequest createRelationshipDefinitionRequest = new CreateRelationshipDefinitionRequest(); // CreateRelationshipDefinitionRequest | The definition of the new relationship.
        try {
            // uncomment the below to set overrides at the request level
            // RelationshipDefinition result = apiInstance.createRelationshipDefinition(createRelationshipDefinitionRequest).execute(opts);

            RelationshipDefinition result = apiInstance.createRelationshipDefinition(createRelationshipDefinitionRequest).execute();
            System.out.println(result.toJson());
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipDefinitionsApi#createRelationshipDefinition");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
createRelationshipDefinitionRequest CreateRelationshipDefinitionRequest The definition of the new relationship.

Return type

RelationshipDefinition

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
201 The newly created relationship 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

deleteRelationshipDefinition

DeletedEntityResponse deleteRelationshipDefinition(scope, code)

[EARLY ACCESS] DeleteRelationshipDefinition: Delete Relationship Definition

Delete the definition of the specified relationship.

Example

import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.RelationshipDefinitionsApi;
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 RelationshipDefinitionsApiExample {

    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);
        // RelationshipDefinitionsApi apiInstance = apiFactory.build(RelationshipDefinitionsApi.class);

        RelationshipDefinitionsApi apiInstance = ApiFactoryBuilder.build(fileName).build(RelationshipDefinitionsApi.class);
        String scope = "scope_example"; // String | The scope of the relationship definition to be deleted.
        String code = "code_example"; // String | The code of the relationship definition to be deleted. Together with the domain and scope this uniquely   identifies the relationship.
        try {
            // uncomment the below to set overrides at the request level
            // DeletedEntityResponse result = apiInstance.deleteRelationshipDefinition(scope, code).execute(opts);

            DeletedEntityResponse result = apiInstance.deleteRelationshipDefinition(scope, code).execute();
            System.out.println(result.toJson());
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipDefinitionsApi#deleteRelationshipDefinition");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
scope String The scope of the relationship definition to be deleted.
code String The code of the relationship definition to be deleted. Together with the domain and scope this uniquely identifies the relationship.

Return type

DeletedEntityResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The time that the relationship definition was 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

getRelationshipDefinition

RelationshipDefinition getRelationshipDefinition(scope, code, asAt)

[EARLY ACCESS] GetRelationshipDefinition: Get relationship definition

Retrieve the specified relationship definition

Example

import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.RelationshipDefinitionsApi;
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 RelationshipDefinitionsApiExample {

    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);
        // RelationshipDefinitionsApi apiInstance = apiFactory.build(RelationshipDefinitionsApi.class);

        RelationshipDefinitionsApi apiInstance = ApiFactoryBuilder.build(fileName).build(RelationshipDefinitionsApi.class);
        String scope = "scope_example"; // String | The scope of the specified relationship definition.
        String code = "code_example"; // String | The code of the specified relationship definition. Together with the domain and scope this uniquely   identifies the relationship definition.
        OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the relationship definition. Defaults to return   the latest version of the definition if not specified.
        try {
            // uncomment the below to set overrides at the request level
            // RelationshipDefinition result = apiInstance.getRelationshipDefinition(scope, code, asAt).execute(opts);

            RelationshipDefinition result = apiInstance.getRelationshipDefinition(scope, code, asAt).execute();
            System.out.println(result.toJson());
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipDefinitionsApi#getRelationshipDefinition");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
scope String The scope of the specified relationship definition.
code String The code of the specified relationship definition. Together with the domain and scope this uniquely identifies the relationship definition.
asAt OffsetDateTime The asAt datetime at which to retrieve the relationship definition. Defaults to return the latest version of the definition if not specified. [optional]

Return type

RelationshipDefinition

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The requested relationship 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

listRelationshipDefinitions

PagedResourceListOfRelationshipDefinition listRelationshipDefinitions(asAt, page, limit, filter, sortBy)

[EARLY ACCESS] ListRelationshipDefinitions: List relationship definitions

Retrieve one or more specified relationship definitions.

Example

import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.RelationshipDefinitionsApi;
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 RelationshipDefinitionsApiExample {

    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);
        // RelationshipDefinitionsApi apiInstance = apiFactory.build(RelationshipDefinitionsApi.class);

        RelationshipDefinitionsApi apiInstance = ApiFactoryBuilder.build(fileName).build(RelationshipDefinitionsApi.class);
        OffsetDateTime asAt = OffsetDateTime.now(); // OffsetDateTime | The asAt datetime at which to retrieve the relationship definitions. Defaults to return   the latest version of each definition if not specified.
        String page = "page_example"; // String | The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This  value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field  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 Scope, use \"scope eq 'ExampleScope'\"   Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
        List<String> sortBy = Arrays.asList(); // List<String> | A list of field names to sort by, each suffixed by \" ASC\" or \" DESC\"
        try {
            // uncomment the below to set overrides at the request level
            // PagedResourceListOfRelationshipDefinition result = apiInstance.listRelationshipDefinitions(asAt, page, limit, filter, sortBy).execute(opts);

            PagedResourceListOfRelationshipDefinition result = apiInstance.listRelationshipDefinitions(asAt, page, limit, filter, sortBy).execute();
            System.out.println(result.toJson());
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipDefinitionsApi#listRelationshipDefinitions");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
asAt OffsetDateTime The asAt datetime at which to retrieve the relationship definitions. Defaults to return the latest version of each definition if not specified. [optional]
page String The pagination token to use to continue listing relationship definitions from a previous call to list relationship definitions. This value is returned from the previous call. If a pagination token is provided the filter, sortBy and asAt field 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 Scope, use &quot;scope eq 'ExampleScope'&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. [optional]
sortBy List<String> A list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; [optional]

Return type

PagedResourceListOfRelationshipDefinition

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The requested relationship definitions -
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

updateRelationshipDefinition

RelationshipDefinition updateRelationshipDefinition(scope, code, updateRelationshipDefinitionRequest)

[EARLY ACCESS] UpdateRelationshipDefinition: Update Relationship Definition

Update the definition of a specified existing relationship. Not all elements within a relationship definition are modifiable due to the potential implications for values already stored against the relationship.

Example

import com.finbourne.lusid.model.*;
import com.finbourne.lusid.api.RelationshipDefinitionsApi;
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 RelationshipDefinitionsApiExample {

    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);
        // RelationshipDefinitionsApi apiInstance = apiFactory.build(RelationshipDefinitionsApi.class);

        RelationshipDefinitionsApi apiInstance = ApiFactoryBuilder.build(fileName).build(RelationshipDefinitionsApi.class);
        String scope = "scope_example"; // String | The scope of the relationship definition being updated.
        String code = "code_example"; // String | The code of the relationship definition being updated. Together with the scope this uniquely   identifies the relationship definition.
        UpdateRelationshipDefinitionRequest updateRelationshipDefinitionRequest = new UpdateRelationshipDefinitionRequest(); // UpdateRelationshipDefinitionRequest | The details of relationship definition to update.
        try {
            // uncomment the below to set overrides at the request level
            // RelationshipDefinition result = apiInstance.updateRelationshipDefinition(scope, code, updateRelationshipDefinitionRequest).execute(opts);

            RelationshipDefinition result = apiInstance.updateRelationshipDefinition(scope, code, updateRelationshipDefinitionRequest).execute();
            System.out.println(result.toJson());
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipDefinitionsApi#updateRelationshipDefinition");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
scope String The scope of the relationship definition being updated.
code String The code of the relationship definition being updated. Together with the scope this uniquely identifies the relationship definition.
updateRelationshipDefinitionRequest UpdateRelationshipDefinitionRequest The details of relationship definition to update.

Return type

RelationshipDefinition

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

HTTP response details

Status code Description Response headers
200 The updated relationship 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