Module Management¶
Get¶
HTTP Request
GET /api/v1/module-management/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "field": "string",
12 "errorKey": "string",
13 "errorMessage": "string"
14 }
15 ]
16 },
17 "object": {
18 "id": 0,
19 "rowNumber": 0,
20 "rowIdentifier": "string",
21 "errors": [
22 "string"
23 ],
24 "linkedErrors": [
25 "string"
26 ],
27 "warnings": [
28 "string"
29 ],
30 "remarks": [
31 "string"
32 ],
33 "skipMessage": "string",
34 "applicationType": "NLA",
35 "enabled": true,
36 "integrated": true
37 }
38}
Update¶
HTTP Request
PUT /api/v1/module-management/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
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 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "field": "string",
12 "errorKey": "string",
13 "errorMessage": "string"
14 }
15 ]
16 },
17 "object": {
18 "id": 0,
19 "rowNumber": 0,
20 "rowIdentifier": "string",
21 "errors": [
22 "string"
23 ],
24 "linkedErrors": [
25 "string"
26 ],
27 "warnings": [
28 "string"
29 ],
30 "remarks": [
31 "string"
32 ],
33 "skipMessage": "string",
34 "applicationType": "NLA",
35 "enabled": true,
36 "integrated": true
37 }
38}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/module-management/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
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 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "field": "string",
12 "errorKey": "string",
13 "errorMessage": "string"
14 }
15 ]
16 },
17 "object": [
18 {
19 "id": 0,
20 "rowNumber": 0,
21 "rowIdentifier": "string",
22 "errors": [
23 "string"
24 ],
25 "linkedErrors": [
26 "string"
27 ],
28 "warnings": [
29 "string"
30 ],
31 "remarks": [
32 "string"
33 ],
34 "skipMessage": "string",
35 "applicationType": "NLA",
36 "enabled": true,
37 "integrated": true
38 }
39 ]
40}
Create Or Update¶
HTTP Request
PUT /api/v1/module-management/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
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 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "field": "string",
12 "errorKey": "string",
13 "errorMessage": "string"
14 }
15 ]
16 },
17 "object": {
18 "id": 0,
19 "rowNumber": 0,
20 "rowIdentifier": "string",
21 "errors": [
22 "string"
23 ],
24 "linkedErrors": [
25 "string"
26 ],
27 "warnings": [
28 "string"
29 ],
30 "remarks": [
31 "string"
32 ],
33 "skipMessage": "string",
34 "applicationType": "NLA",
35 "enabled": true,
36 "integrated": true
37 }
38}
Bulk Update¶
HTTP Request
PUT /api/v1/module-management/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
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 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "field": "string",
12 "errorKey": "string",
13 "errorMessage": "string"
14 }
15 ]
16 },
17 "object": [
18 {
19 "id": 0,
20 "rowNumber": 0,
21 "rowIdentifier": "string",
22 "errors": [
23 "string"
24 ],
25 "linkedErrors": [
26 "string"
27 ],
28 "warnings": [
29 "string"
30 ],
31 "remarks": [
32 "string"
33 ],
34 "skipMessage": "string",
35 "applicationType": "NLA",
36 "enabled": true,
37 "integrated": true
38 }
39 ]
40}
Search¶
HTTP Request
POST /api/v1/module-management/search
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 |
body |
body |
false |
none |
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 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
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}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationTypeStr |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Is Enabled¶
HTTP Request
GET /api/v1/module-management/is-enabled/{applicationTypeStr}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
applicationTypeStr |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
Example Responses
1true
Find All¶
HTTP Request
GET /api/v1/module-management
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
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}