Internal Asset Class

Internal Asset Class - Get

HTTP Request

GET /api/v1/internal-asset-classes/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific internal asset class within the financial organization structure, identified by the provided ID, to support organizational hierarchy and asset management needs.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Update

HTTP Request

PUT /api/v1/internal-asset-classes/{id}

Interactive Demo

📋 Description: Updates the details of a specific internal asset class within the financial organization structure, identified by its unique ID, to reflect changes in the organization’s hierarchy or financial entity classification.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	InternalAssetClassDto	true	Request body containing the updated details of the internal asset class, including attributes related to the organization’s financial structure and hierarchy.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "assetClassType": "PROPERTY",
  "infiniteUsefulLife": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Delete

HTTP Request

DELETE /api/v1/internal-asset-classes/{id}

Interactive Demo

📋 Description: Deletes a specified internal asset class from the financial organization structure, ensuring the integrity of the hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Delete Or Decommission

HTTP Request

PUT /api/v1/internal-asset-classes/remove/{id}

Interactive Demo

📋 Description: Removes a specified internal asset class from the financial organization structure, ensuring the hierarchy remains accurate and up-to-date for effective management of financial entities.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Delete Or Decommission All

HTTP Request

PUT /api/v1/internal-asset-classes/remove/bulk

Interactive Demo

📋 Description: Removes multiple internal asset classes from the financial organization structure, enabling efficient management of the entity’s hierarchy and ensuring alignment with organizational changes.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of internal asset class identifiers to be removed in bulk from the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Decommission

HTTP Request

PUT /api/v1/internal-asset-classes/decommission/{id}

Interactive Demo

📋 Description: Decommissions a specified internal asset class within the financial organization structure, effectively removing it from the active hierarchy of financial entities. This operation ensures that the organization’s asset classifications remain current and relevant.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Decommission By Modification Date Before

HTTP Request

PUT /api/v1/internal-asset-classes/decommission/modified-before/{modified_before}

Interactive Demo

📋 Description: Decommissions internal asset classes that were modified before the specified date, ensuring the financial organization structure remains current and aligned with operational needs. This operation is essential for maintaining an accurate hierarchy within the financial entity.

Parameters

Name	In	Type	Required	Description
modified_before	path	string(date-time)	true	Specifies the date and time before which internal asset classes must have been modified for decommissioning within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Decommission Before Now

HTTP Request

PUT /api/v1/internal-asset-classes/decommission/modified-before-now

Interactive Demo

📋 Description: Updates the status of internal asset classes that were modified before the current date to ‘decommissioned,’ ensuring the financial organization structure reflects accurate and up-to-date hierarchy management.

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Decommission All

HTTP Request

PUT /api/v1/internal-asset-classes/decommission/bulk

Interactive Demo

📋 Description: Decommissions multiple internal asset classes in a financial organization structure, allowing for efficient management of the entity’s hierarchy and organizational resources.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing a list of internal asset classes to be decommissioned in bulk, including relevant identifiers and metadata for financial organization structure management.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Create Or Update Bulk

HTTP Request

PUT /api/v1/internal-asset-classes/createOrUpdate/bulk

Interactive Demo

📋 Description: Updates or creates multiple internal asset classes within the financial organization structure, enabling efficient management of organizational hierarchy and financial entities.

Parameters

Name	In	Type	Required	Description
body	body	InternalAssetClassDto	true	Request body containing bulk data for creating or updating internal asset classes within the financial organization structure, including relevant attributes and hierarchy details.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Create Or Update

HTTP Request

PUT /api/v1/internal-asset-classes/createOrUpdate

Interactive Demo

📋 Description: Creates or updates internal asset classes within the financial organization structure, ensuring alignment with the organization’s hierarchy and entity requirements.

Parameters

Name	In	Type	Required	Description
body	body	InternalAssetClassDto	true	Request body containing the financial organization structure data for creating or updating internal asset classes, including relevant attributes and hierarchical relationships.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "assetClassType": "PROPERTY",
  "infiniteUsefulLife": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Bulk Update

HTTP Request

PUT /api/v1/internal-asset-classes/bulk

Interactive Demo

📋 Description: Updates multiple internal asset classes within the financial organization structure, allowing for efficient management of organizational hierarchy and alignment of financial entities.

Parameters

Name	In	Type	Required	Description
body	body	InternalAssetClassDto	true	Request body containing a bulk update of internal asset class data, including identifiers, attributes, and hierarchical relationships relevant to the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Bulk Create

HTTP Request

POST /api/v1/internal-asset-classes/bulk

Interactive Demo

📋 Description: Creates multiple internal asset classes in bulk for a financial organization, facilitating the efficient management of the organization’s structure and hierarchy.

Parameters

Name	In	Type	Required	Description
body	body	InternalAssetClassDto	true	Request body containing a collection of internal asset class definitions, including hierarchical relationships and attributes relevant to the financial organization structure.

Body Parameters

[
  {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Bulk Delete

HTTP Request

DELETE /api/v1/internal-asset-classes/bulk

Interactive Demo

📋 Description: Deletes multiple internal asset classes from the financial organization structure, allowing for streamlined management of the entity’s hierarchical classifications.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of internal asset class identifiers to be deleted in bulk from the financial organization structure.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Search

HTTP Request

POST /api/v1/internal-asset-classes/search

Interactive Demo

📋 Description: Submits a search request for internal asset classes within the financial organization structure, enabling users to identify and analyze hierarchical relationships among financial entities.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	InternalAssetClassDtoFilter	false	Request body containing search criteria for internal asset classes, including relevant organizational hierarchy and financial entity attributes.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "statusEqual": "CREATED",
  "statusIn": [
    "CREATED"
  ],
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "uiSelector": "string",
  "nameLike": "string",
  "assetClassTypeIn": [
    "PROPERTY"
  ],
  "infiniteUsefulLifeEqual": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalAssetClassDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Find All

HTTP Request

GET /api/v1/internal-asset-classes

Interactive Demo

📋 Description: Retrieves a list of internal asset classes within the financial organization structure, providing insights into the hierarchy and classification of financial entities. This operation supports effective management and analysis of organizational assets.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the internal asset classes query should be paginated, facilitating efficient data retrieval within the financial organization structure.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageInternalAssetClassDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "status": "CREATED",
      "displayId": "string",
      "name": "string",
      "assetClassType": "PROPERTY",
      "infiniteUsefulLife": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Create

HTTP Request

POST /api/v1/internal-asset-classes

Interactive Demo

📋 Description: Creates a new internal asset class within the financial organization structure, enabling the classification and management of financial entities in a hierarchical framework.

Parameters

Name	In	Type	Required	Description
body	body	InternalAssetClassDto	true	Request body containing the details of new internal asset classes, including classification attributes and hierarchical relationships within the financial organization structure.

Body Parameters

{
  "id": 0,
  "status": "CREATED",
  "displayId": "string",
  "name": "string",
  "assetClassType": "PROPERTY",
  "infiniteUsefulLife": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseInternalAssetClassDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "status": "CREATED",
    "displayId": "string",
    "name": "string",
    "assetClassType": "PROPERTY",
    "infiniteUsefulLife": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Asset Class - Get Metadata

HTTP Request

GET /api/v1/internal-asset-classes/meta

Interactive Demo

📋 Description: Retrieves metadata for internal asset classes within the financial organization structure, providing insights into the hierarchy and classification of financial entities.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "NAME"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---