Module Management¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/module-management/{id}
📋 Description: Retrieves detailed information about a specific financial entity’s organizational structure and hierarchy by its unique identifier.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "applicationType": "NLA",
32 "enabled": true,
33 "integrated": true
34 }
35}
Update A Resource¶
HTTP Request
PUT /api/v1/module-management/{id}
📋 Description: Updates the details of a specified financial entity within the organization’s hierarchical structure, allowing for modifications to its attributes and relationships. This operation ensures that the financial organization structure remains accurate and aligned with business needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated organizational structure data, including hierarchy details and financial entity attributes, for the specified module. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "applicationType": "NLA",
19 "enabled": true,
20 "integrated": true
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "applicationType": "NLA",
32 "enabled": true,
33 "integrated": true
34 }
35}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/module-management/createOrUpdate/bulk
📋 Description: Updates or creates multiple entries in the financial organization structure, allowing for efficient management of hierarchy and relationships within financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing bulk data for creating or updating the financial organization structure, including details on the hierarchy and attributes of each financial entity. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "applicationType": "NLA",
20 "enabled": true,
21 "integrated": true
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "applicationType": "NLA",
33 "enabled": true,
34 "integrated": true
35 }
36 ]
37}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/module-management/createOrUpdate
📋 Description: Creates or updates the financial organization structure by defining or modifying the hierarchy of financial entities within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the financial organization structure data, including details on the hierarchy and attributes of the financial entity to be created or updated. |
Body Parameters
1{
2 "id": 0,
3 "rowNumber": 0,
4 "rowIdentifier": "string",
5 "errors": [
6 "string"
7 ],
8 "linkedErrors": [
9 "string"
10 ],
11 "warnings": [
12 "string"
13 ],
14 "remarks": [
15 "string"
16 ],
17 "skipMessage": "string",
18 "applicationType": "NLA",
19 "enabled": true,
20 "integrated": true
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "rowNumber": 0,
17 "rowIdentifier": "string",
18 "errors": [
19 "string"
20 ],
21 "linkedErrors": [
22 "string"
23 ],
24 "warnings": [
25 "string"
26 ],
27 "remarks": [
28 "string"
29 ],
30 "skipMessage": "string",
31 "applicationType": "NLA",
32 "enabled": true,
33 "integrated": true
34 }
35}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/module-management/bulk
📋 Description: Updates the financial organization structure in bulk, allowing for the efficient modification of multiple financial entities’ hierarchies and relationships within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a bulk update of financial organization structure data, including hierarchical relationships and attributes of financial entities. |
Body Parameters
1[
2 {
3 "id": 0,
4 "rowNumber": 0,
5 "rowIdentifier": "string",
6 "errors": [
7 "string"
8 ],
9 "linkedErrors": [
10 "string"
11 ],
12 "warnings": [
13 "string"
14 ],
15 "remarks": [
16 "string"
17 ],
18 "skipMessage": "string",
19 "applicationType": "NLA",
20 "enabled": true,
21 "integrated": true
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "rowNumber": 0,
18 "rowIdentifier": "string",
19 "errors": [
20 "string"
21 ],
22 "linkedErrors": [
23 "string"
24 ],
25 "warnings": [
26 "string"
27 ],
28 "remarks": [
29 "string"
30 ],
31 "skipMessage": "string",
32 "applicationType": "NLA",
33 "enabled": true,
34 "integrated": true
35 }
36 ]
37}
Search Resources¶
HTTP Request
POST /api/v1/module-management/search
📋 Description: Submits a search query to retrieve financial entities within the organization’s structure and hierarchy, enabling efficient navigation and management of the financial organization framework.
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 |
false |
Request body containing search criteria and filters for retrieving organizational structure data related to financial entities within the hierarchy. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "applicationTypeEqual": "NLA",
16 "applicationTypeIn": [
17 "NLA"
18 ],
19 "enabledEqual": true,
20 "integratedEqual": true
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "pageSize": 0,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "applicationType": "NLA",
37 "enabled": true,
38 "integrated": true
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}
Is Integrated¶
HTTP Request
GET /api/v1/module-management/is-integrated/{applicationTypeStr}
📋 Description: Retrieves the integration status of a specified financial application type within the organization’s structure, providing insights into the hierarchy and connectivity of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationTypeStr |
path |
string |
true |
Specifies the type of application to determine its integration status within the financial organization structure. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Is Enabled¶
HTTP Request
GET /api/v1/module-management/is-enabled/{applicationTypeStr}
📋 Description: Retrieves the enabled status of a specified application type within the financial organization structure, facilitating insights into the hierarchy and operational capabilities of financial entities.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationTypeStr |
path |
string |
true |
Specifies the type of application for which the financial organization structure’s module management status is being queried. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
List All Resources¶
HTTP Request
GET /api/v1/module-management
📋 Description: Retrieves the hierarchical structure of financial entities within the organization, providing insights into the organization’s financial management framework.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the organization structure retrieval should be paginated, facilitating efficient navigation through the financial entity hierarchy. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "pageSize": 0,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "rowNumber": 0,
22 "rowIdentifier": "string",
23 "errors": [
24 "string"
25 ],
26 "linkedErrors": [
27 "string"
28 ],
29 "warnings": [
30 "string"
31 ],
32 "remarks": [
33 "string"
34 ],
35 "skipMessage": "string",
36 "applicationType": "NLA",
37 "enabled": true,
38 "integrated": true
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}