General Setting¶
Get¶
HTTP Request
GET /api/v1/general-settings/{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 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
Update¶
HTTP Request
PUT /api/v1/general-settings/{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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
Delete¶
HTTP Request
DELETE /api/v1/general-settings/{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 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/general-settings/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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
Create Or Update¶
HTTP Request
PUT /api/v1/general-settings/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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
Bulk Update¶
HTTP Request
PUT /api/v1/general-settings/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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
Bulk Create¶
HTTP Request
POST /api/v1/general-settings/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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
20 "value": "string"
21 }
22]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
33 "value": "string"
34 }
35 ]
36}
Bulk Delete¶
HTTP Request
DELETE /api/v1/general-settings/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search¶
HTTP Request
POST /api/v1/general-settings/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 "generalSettingTypeIn": [
16 "PRINCIPAL_POSITION_MODE"
17 ],
18 "valueEqual": "string",
19 "valueLike": "string"
20}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": 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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
37 "value": "string"
38 }
39 ],
40 "number": 0,
41 "sort": {
42 "sorted": true,
43 "unsorted": true,
44 "empty": true
45 },
46 "first": true,
47 "last": true,
48 "empty": true
49}
Find All¶
HTTP Request
GET /api/v1/general-settings
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 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": 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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
37 "value": "string"
38 }
39 ],
40 "number": 0,
41 "sort": {
42 "sorted": true,
43 "unsorted": true,
44 "empty": true
45 },
46 "first": true,
47 "last": true,
48 "empty": true
49}
Create¶
HTTP Request
POST /api/v1/general-settings
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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
19 "value": "string"
20}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "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 "generalSettingType": "PRINCIPAL_POSITION_MODE",
32 "value": "string"
33 }
34}
Get Metadata¶
HTTP Request
GET /api/v1/general-settings/meta
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "GENERAL_SETTING_TYPE"
3]